Authorizations
Body
Human readable name of campaign
"Outbound Campaign 1"
Variables for campaign
{ "key": "value", "key2": "value2" }
Caller ID for call
19995551234
Days of the week when campaign is active
"[\"mon\", \"tue\", \"wed\", \"thu\", \"fri\"]"
Description of campaign
"This is a test campaign"
Mode of the campaign (e.g. voice, sms)
"voice"
"sms"
Time to live for SMS session in minutes
720
Label for campaign (DEPRECATED - use labels instead)
"test"
"demo"
Labels for campaign
["test", "demo"]
Start time of campaign each day
"09:00:00"
End time of campaign each day
"17:00:00"
Source phone number, email, or SMS number
"+19032900844"
"account@email.com"
Target number of outreach calls per hour
25
Number of retries per target
1
How long to wait before retrying
"30m"
"12h"
"7d"
Response
Successful Response
Human readable name of campaign
"Outbound Campaign 1"
Variables for campaign
{ "key": "value", "key2": "value2" }
Caller ID for call
19995551234
Days of the week when campaign is active
"[\"mon\", \"tue\", \"wed\", \"thu\", \"fri\"]"
Unique ID for campaign
1
Email of user who last updated campaign
"user@email.com"
Description of campaign
"This is a test campaign"
Mode of the campaign (e.g. voice, sms)
"voice"
"sms"
Time to live for SMS session in minutes
720
Label for campaign (DEPRECATED - use labels instead)
"test"
"demo"
Labels for campaign
["test", "demo"]
Start time of campaign each day
"09:00:00"
End time of campaign each day
"17:00:00"
Source phone number, email, or SMS number
"+19032900844"
"account@email.com"
Target number of outreach calls per hour
25
Number of retries per target
1
How long to wait before retrying
"30m"
"12h"
"7d"
ID of agent assigned to campaign
"agent_id"
Timestamp of campaign creation
"2025-09-10T00:00:00Z"
Timestamp of campaign update
"2025-09-10T00:00:00Z"