v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-01979563.0 MB

Campaigns

Update Campaign

patch/v2/campaign/{id}

Path parameters

idstring uuid required

The unique identifier for the resource.

Request body

namestring

This is the name of the campaign. This is just for your own reference.

assistantIdstring

This is the assistant ID that will be used for the campaign calls. Can only be updated if campaign is not in progress or has ended.

workflowIdstring

This is the workflow ID that will be used for the campaign calls. Can only be updated if campaign is not in progress or has ended.

squadIdstring

This is the squad ID that will be used for the campaign calls. Can only be updated if campaign is not in progress or has ended.

phoneNumberIdstring

This is the phone number ID that will be used for the campaign calls. Can only be updated if campaign is not in progress or has ended. Note: phoneNumberId and dialPlan are mutually exclusive.

status'ended' | 'cancelled'

Set to 'cancelled' to stop the campaign ('ended' is a V1 alias). Scheduled calls are deleted; in-progress calls are allowed to finish.

Response

status'scheduled' | 'in-progress' | 'ended' | 'cancelled' | 'archived' required

This is the status of the campaign.

endedReason'campaign.scheduled.ended-by-user' | 'campaign.in-progress.ended-by-user' | 'campaign.ended.success'

This is the explanation for how the campaign ended.

namestring required

This is the name of the campaign. This is just for your own reference.

assistantIdstring

This is the assistant ID that will be used for the campaign calls. Note: Only one of assistantId, workflowId, or squadId can be used.

workflowIdstring

This is the workflow ID that will be used for the campaign calls. Note: Only one of assistantId, workflowId, or squadId can be used.

squadIdstring

This is the squad ID that will be used for the campaign calls. Note: Only one of assistantId, workflowId, or squadId can be used.

phoneNumberIdstring

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.

maxConcurrencynumber

This is the maximum number of concurrent calls that will be made for the campaign. Defaults to 10.

serverMessagesstring[]

These are the messages that will be sent to your Server URL.

idstring required

This is the unique identifier for the campaign.

orgIdstring required

This is the unique identifier for the org that this campaign belongs to.

createdAtstring date-time required

This is the ISO 8601 date-time string of when the campaign was created.

updatedAtstring date-time required

This is the ISO 8601 date-time string of when the campaign was last updated.

callsobject required

This is a map of call IDs to campaign call details.

callsCounterSchedulednumber required

This is the number of calls that have been scheduled.

callsCounterQueuednumber required

This is the number of calls that have been queued.

callsCounterInProgressnumber required

This is the number of calls that have been in progress.

callsCounterEndedVoicemailnumber required

This is the number of calls whose ended reason is 'voicemail'.

callsCounterEndednumber required

This is the number of calls that have ended.