Sign in
Campaigns

Update Campaign

patch/campaign/{id}

Path parameters

idstring required

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.

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.

status'ended'

This is the status of the campaign. Can only be updated to 'ended' if you want to end the campaign. When set to 'ended', it will delete all scheduled calls. Calls in progress will be allowed to complete.

Response

status'scheduled' | 'in-progress' | 'ended' 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: Either assistantId or workflowId can be used, but not both.

workflowIdstring

This is the workflow ID that will be used for the campaign calls. Note: Either assistantId or workflowId can be used, but not both.

phoneNumberIdstring required

This is the phone number ID that will be used for the campaign calls.

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.

Changes