CAcarecycle
Sources

Update an existing source

Change a lead source's settings. Price changes only apply from now on. Past charges keep the amount they had when they happened, so old reports don't change.

patch/v2/sources/{id}

Request

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

Path parameters

idstring uuid required

PATCH /v2/sources/:id Parameter

Request body

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

Response

PATCH /v2/sources/:id 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

Changes

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