CAcarecycle
Sources

Create a new source

Create a lead source to track where leads and calls come from. You can connect it to a campaign at the same time. Enabled live-call assignments require an existing campaign-owned tracking number; this operation never purchases numbers. Set createPingPostKey to explicitly request a one-time source-scoped vendor key.

post/v2/sources

Request

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

Request body

createPingPostKeyboolean

Explicitly issue a vendor ping-post key for a live-call integration

sourceIdstring
namestring
descriptionstring
labelstring
typestring
channelstring
status'active' | 'inactive' | 'archived'
dealType'CPA' | 'CPL' required
pricingModel'flat_rate' | 'percentage' | 'dynamic' | 'static' | 'duration' required
payoutstring
commissionPerSalestring
leadCoststring
durationThresholdstring
externalRefsobject
metadataobject

Response

POST /v2/sources Positive response

idstring uuid required
sourceIdstring required
clientIdstring uuid required
namestring nullable required
descriptionstring nullable required
labelstring nullable
typestring nullable
channelstring nullable
status'active' | 'inactive' | 'archived' required
dealType'CPA' | 'CPL' required
pricingModel'flat_rate' | 'percentage' | 'dynamic' | 'static' | 'duration' required
payoutstring nullable required
commissionPerSalestring nullable required
leadCoststring nullable required
durationThresholdstring nullable required
externalRefsobject nullable
metadataobject nullable
createdAtstring date-time nullable required

Source creation time. ISO 8601 timestamp

updatedAtstring date-time nullable required

Source last update time. ISO 8601 timestamp

assignmentCountinteger required
leadDestinationCampaignIdstring uuid nullable
leadDestinationCampaignNamestring nullable
pingPostApiKeystring nullable required

Changes

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