Table of Contents:
Table of Contents minLevel 2
Note: Notice that in each API call you must provide the List ID that you are working on, otherwise the default List ID will be used.
Methods Summary
DELETE /api/events/<Event ID>
Description
This method deletes an event.
GET /api/events/<Event ID>
Description
This method gets a single event.
GET /api/events
Description
This method fetches a collection of events.
...
Optional int
limit
Optional int
POST /api/events
Description
This method creates a new event.
...
*schedule_minute Required - integer - Schedule minute (0-59)
*reccurance recurrence Required - object - associative object of key & values with the following acceptable keys:
*pattern -string- (acceptable values: "daily")
Example - Event based on birth_date field
POST URL: https://api.ongage.net/<list_id>/api/events
- First trigger will be sent at 10:30 on contact's birth date
- Second trigger will be sent after 7 days only if the contact didn't open first trigger's message, the email will be sent at 19:45
...
| Code Block |
|---|
{
"name": "Based on mailing",
"based_on": "mailing",
"status": true,
"segments": [ 60659 ],
"mailing_id": 35847,
"start_date": "2017-12-15",
"end_date": "2017-12-25",
"distribution": [
{
"esp_connection_id": 60142,
"domain": "default",
"percent": 100
}
],
"triggers": [
{
"based_on": "mailing",
"email_messages": [ 2381 ],
"days_diff": 0,
"operator": "after",
"email_operator": "not_opened",
"schedule_hour": 10,
"schedule_minute": 30
}
]
} |
PUT /api/events/<Event ID>
Description
This method is used to update an existing event.
...
Optional array - Update global emails quota
PUT /api/events/<Event ID>/status
Description
This method is used to Toggle the event status.
...