Example: trigger_123Match pattern: trigger_\d+
The resource in the response. Always trigger.Allowed value: trigger
ISO 8601 date-time string.Example: 2023-01-01T10:00+00:00
ISO 8601 date-time string.Example: 2023-01-01T10:00+00:00
One of immediate, schedule or recurring.Allowed values: schedule, immediate, recurring
Used when launching a campaign to send at a specific time in the future.
scheduled_at
string<date-time>
required
ISO 8601 date-time string.Example: 2023-01-01T10:00+10:00
Number of batches. Minimum: 1.
Delay in seconds.Example: 3600
Used when launching a campaign to send immediately.
Number of batches. Minimum: 1.
Delay in seconds.Example: 3600
Used when launching a campaign to run on a recurring schedule.
A cron string.Example: * 12 2 * *
ISO 8601 date-time string representing when the next campaign_run will be sent.Example: 2023-01-01T10:00+10:00
Number of batches. Minimum: 1.
Delay in minutes.Example: 60
Example (Schedule)
{
"id": "trigger_123",
"object": "trigger",
"created_at": "2023-01-01T10:00+00:00",
"updated_at": "2023-01-01T10:00+00:00",
"type": "schedule",
"schedule": {
"scheduled_at": "2023-01-01T10:00+10:00",
"batches": {
"count": 3,
"delay": 3600
}
}
}
{
"id": "trigger_456",
"object": "trigger",
"created_at": "2023-01-01T10:00+00:00",
"updated_at": "2023-01-01T10:00+00:00",
"type": "immediate",
"immediate": {
"batches": {
"count": 2,
"delay": 1800
}
}
}
Example (Recurring)
{
"id": "trigger_789",
"object": "trigger",
"created_at": "2023-01-01T10:00+00:00",
"updated_at": "2023-01-01T10:00+00:00",
"type": "recurring",
"recurring": {
"schedule": "* 12 2 * *",
"next_scheduled_at": "2023-02-01T12:00+10:00",
"batches": {
"count": 1,
"delay": 60
}
}
}
