Go to ZyloLegacy API Documentation
API Reference
Start typing to search…

Create an Alert

post
https://api.zylo.com/v2/alerts

Required Permissions

applications:write

Rate Limit

limited

Important Note

When creating an alert, refer to the Alerts documentation for guidance. This contains important information on configuring alert settings.

Body Params
string | null

Stringified UUIDv4.

string | null

Stringified UUIDv4.

string | null

The alert memo. This is additional information included in the alert notification.

string
required

Email address of the Owner. The email must belong to a user in the Zylo system.

string
required

Dynamic configuration for the alert, including recipients and type-specific settings.

string
enum
required

Type of alert. There are three types of alerts; contract-renewal, renewal, and transaction.

Allowed:
Response

Updated 3 days ago

Language
Credentials
Bearer
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 3 days ago