CAcarecycle
Campaigns

Update a campaign

Change a campaign's settings, like its name, description, retry rules, and text messages.

patch/v2/campaigns/{campaignId}

Request

  • Base URL
    https://api.carecycle.ai
  • URL
    https://api.carecycle.ai/v2/campaigns/{campaignId}
  • Auth
    API key in header x-api-key

Path parameters

campaignIdstring uuid required

Campaign ID

Request body

callerIdSource'client_main' | 'campaign_pool'
namestring
descriptionstring nullable
status'draft' | 'active' | 'paused' | 'completed' | 'archived' | 'cancelled'
maxConcurrentCallsinteger nullable
pulseWorkflowIdstring uuid nullable
endDatestring date-time nullable
appointmentConfigIdstring uuid nullable
callFormIdstring uuid nullable
tagsstring[]
kind'voice_ai' | 'agent_first'
primaryVoicemailGreetingstring nullable
afterHoursVoicemailGreetingstring nullable
smsCompanyNamestring
expectedConfigurationRevisioninteger
expectedUpdatedAtstring date-time

Campaign revision read before editing. Stale revisions return HTTP 409.

transferConfigIdsstring[] nullable

Campaign-assigned transfer configs. Ordered list, first item is default.

Response

PATCH /v2/campaigns/:campaignId Positive response

Changes

No recorded changes to this operation across all 2 revisions of this API.