CAcarecycle
Campaigns

Create Campaign

Create a new campaign as a draft. You can start from a template.

post/v2/campaigns

Request

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

Request body

callerIdSource'client_main' | 'campaign_pool'
namestring

Campaign name. A missing or blank name becomes "Untitled campaign".

descriptionstring nullable

Campaign description

templateIdstring uuid nullable

Optional campaign template ID

maxConcurrentCallsinteger nullable

Optional Pulse call concurrency cap for this campaign

direction'inbound' | 'outbound'

Campaign direction

kind'voice_ai' | 'agent_first'

Campaign kind (defaults to voice_ai)

Response

POST /v2/campaigns Positive response

warningsstring[]

Creation compatibility notices, including incomplete older template snapshots

Changes

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