CAcarecycle
Sources

Update a source campaign assignment

Change how a lead source is set up for one campaign.

patch/v2/source-assignments/{id}

Request

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

Path parameters

idstring uuid required

PATCH /v2/source-assignments/:id Parameter

Request body

sourceType'outbound' | 'inbound'
phoneNumberIdinteger nullable
enabledboolean
unassignedAtstring date-time nullable

Source unassignment time. ISO 8601 timestamp

metadataobject nullable

Response

PATCH /v2/source-assignments/:id 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.