Create Campaign V2
Authentication
Request
This is the assistant ID that will be used for the campaign calls. Note: Only one of assistantId, workflowId, or squadId can be used.
This is the workflow ID that will be used for the campaign calls. Note: Only one of assistantId, workflowId, or squadId can be used.
This is the squad ID that will be used for the campaign calls. Note: Only one of assistantId, workflowId, or squadId can be used.
This is the phone number ID that will be used for the campaign calls. Required if dialPlan is not provided. Note: phoneNumberId and dialPlan are mutually exclusive.
This is a list of dial entries, each specifying a phone number and the customers to call using that number. Use this when you want different phone numbers to call different sets of customers. Note: phoneNumberId and dialPlan are mutually exclusive.
This is the schedule plan for the campaign. Calls will start at startedAt and continue until your organization’s concurrency limit is reached. Any remaining calls will be retried for up to one hour as capacity becomes available. After that hour or after latestAt, whichever comes first, any calls that couldn’t be placed won’t be retried.
These are the overrides for the assistant’s settings and template variables for the campaign. Use this when the campaign targets an assistantId.
These are the overrides for the squad and template variables for the campaign. Use this when the campaign targets a squadId. Per-contact squadOverrides are deep-merged on top of this at dispatch time.
This is the server (URL, auth headers, timeout, etc.) for the campaign webhooks.
This opts the campaign into the blocking campaign.predial eligibility webhook. When set, every contact triggers a campaign.predial POST to the Server URL before dialing, and the response { eligible: boolean } decides whether the call is placed. Requires server. When unset, no pre-dial webhook is sent.
Optional campaign ID to duplicate config from. Provided fields in the request override the source. If customers is omitted, contacts are copied from the source.
Response
This is the ISO 8601 date-time string of when the campaign was created.
This is the ISO 8601 date-time string of when the campaign was last updated.
This is the assistant ID that will be used for the campaign calls. Note: Only one of assistantId, workflowId, or squadId can be used.
This is the workflow ID that will be used for the campaign calls. Note: Only one of assistantId, workflowId, or squadId can be used.
This is the squad ID that will be used for the campaign calls. Note: Only one of assistantId, workflowId, or squadId can be used.
This is the phone number ID that will be used for the campaign calls. Required if dialPlan is not provided. Note: phoneNumberId and dialPlan are mutually exclusive.
This is a list of dial entries, each specifying a phone number and the customers to call using that number. Use this when you want different phone numbers to call different sets of customers. Note: phoneNumberId and dialPlan are mutually exclusive.
This is the schedule plan for the campaign. Calls will start at startedAt and continue until your organization’s concurrency limit is reached. Any remaining calls will be retried for up to one hour as capacity becomes available. After that hour or after latestAt, whichever comes first, any calls that couldn’t be placed won’t be retried.
These are the overrides for the assistant’s settings and template variables for the campaign. Use this when the campaign targets an assistantId.
These are the overrides for the squad and template variables for the campaign. Use this when the campaign targets a squadId. Per-contact squadOverrides are deep-merged on top of this at dispatch time.
This is the server (URL, auth headers, timeout, etc.) for the campaign webhooks.
This opts the campaign into the blocking campaign.predial eligibility webhook. When set, every contact triggers a campaign.predial POST to the Server URL before dialing, and the response { eligible: boolean } decides whether the call is placed. Requires server. When unset, no pre-dial webhook is sent.