curl --request POST \
--url https://api-prod.interactly.ai/campaigns/v1/schedule/calls \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"config": {
"name": "<string>",
"timezone": "America/New_York",
"startHours": 9,
"endHours": 17,
"reportEmails": [
"<string>"
],
"maxParallelCalls": 2,
"isReviewRequired": true,
"reviewEmails": [
"<string>"
],
"maxRetries": 0,
"uidExtension": "datetime",
"schedule": [
{}
],
"assistantNumbers": [
"<string>"
],
"webhook": {
"enabled": false,
"url": "<string>",
"secret": "<string>",
"headers": [
{
"key": "<string>",
"value": "<string>",
"sensitive": false
}
],
"events": [
"call_status"
]
}
},
"data": [
{}
]
}
'{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Create a new campaign call configuration in bulk.
curl --request POST \
--url https://api-prod.interactly.ai/campaigns/v1/schedule/calls \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"config": {
"name": "<string>",
"timezone": "America/New_York",
"startHours": 9,
"endHours": 17,
"reportEmails": [
"<string>"
],
"maxParallelCalls": 2,
"isReviewRequired": true,
"reviewEmails": [
"<string>"
],
"maxRetries": 0,
"uidExtension": "datetime",
"schedule": [
{}
],
"assistantNumbers": [
"<string>"
],
"webhook": {
"enabled": false,
"url": "<string>",
"secret": "<string>",
"headers": [
{
"key": "<string>",
"value": "<string>",
"sensitive": false
}
],
"events": [
"call_status"
]
}
},
"data": [
{}
]
}
'{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Retrieve your API Key from Dashboard API Keys Section.
Campaign call configuration data
Show child attributes
Campaign name
Represents the configuration for webhooks.
Show child attributes
Enable/disable webhooks. When enabled, webhook notifications will be sent based on the configured events.
The endpoint URL where Interactly will send webhook notifications about campaign and call events using HTTP POST requests.
An optional secret key used for authenticating webhook requests. Each request will include this key in the 'x-interactly-secret' header to help you verify that the request originated from Interactly.
A list of additional HTTP headers to include with each webhook request. These headers can be used to authenticate your webhook endpoint or send custom metadata. Headers marked as sensitive will have their values encrypted before storage. All headers will be automatically included in every webhook request.
Show child attributes
The name of the HTTP header to include in the webhook request (e.g., 'Authorization').
The value of the HTTP header (e.g., 'Bearer token'). This value will be encrypted if marked as sensitive.
If true, the header value will be encrypted and stored securely in the database.
The list of events for which webhook notifications will be sent. You can choose one or more events to receive notifications about specific campaign and call activities.
Enum representing different webhook events.
call_status, campaign_report Successful Response