CAcarecycle
Sources

Assign a source to a campaign

Connect a lead source to a campaign. Choose how leads arrive (the acquisition type) and, if you want, an existing tracking number. Connecting the same source again keeps its current setup and number. The campaign still decides how calls are handled.

post/v2/sources/{id}/assignments

Request

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

Path parameters

idstring uuid required

POST /v2/sources/:id/assignments Parameter

Request body

campaignIdstring uuid required
sourceType'outbound' | 'inbound'

Acquisition type: outbound for lead records, inbound for live calls. Independent of campaign direction.

phoneNumberIdinteger nullable
enabledboolean
metadataobject nullable

Response

POST /v2/sources/:id/assignments Positive response

idstring uuid required
sourceIdstring uuid required
campaignIdstring uuid required
campaignNamestring nullable
direction'outbound' | 'inbound' required
enabledboolean required
phoneNumberIdinteger nullable required
phoneNumberstring nullable
service'mobius' | 'softphone' | 'null' nullable
assignedAtstring date-time nullable required

Source assignment time. ISO 8601 timestamp

unassignedAtstring date-time nullable required

Source unassignment time. ISO 8601 timestamp

metadataobject nullable

Changes

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