Skip to main content
PATCH
/
v2
/
sources
/
{id}
Update an existing source
curl --request PATCH \
  --url https://api.carecycle.ai/v2/sources/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "dealType": "CPA",
  "pricingModel": "flat_rate",
  "payout": "<string>",
  "commissionPerSale": "<string>",
  "leadCost": "<string>",
  "durationThreshold": "<string>",
  "enabled": true
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sourceId": "<string>",
  "name": "<string>",
  "description": "<string>",
  "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "phoneNumberId": -1,
  "dealType": "CPA",
  "sourceType": "outbound",
  "pricingModel": "flat_rate",
  "payout": "<string>",
  "commissionPerSale": "<string>",
  "leadCost": "<string>",
  "durationThreshold": "<string>",
  "enabled": true,
  "createdAt": "<unknown>",
  "updatedAt": "<unknown>",
  "campaignName": "<string>"
}

Authorizations

​
x-api-key
string
header
required

API key required for authentication.

Keys begin with 'cc_' prefix. Get your API key from the Developer Dashboard.

Path Parameters

​
id
string<uuid>
required

PATCH /v2/sources/:id Parameter

Body

application/json

PATCH /v2/sources/:id Request body

​
name
string
​
description
string
Maximum string length: 1000
​
dealType
enum<string>
Available options:
CPA,
CPL
​
pricingModel
enum<string>
Available options:
flat_rate,
percentage,
dynamic,
static,
duration
​
payout
string
​
commissionPerSale
string
​
leadCost
string
​
durationThreshold
string
​
enabled
boolean

Response

PATCH /v2/sources/:id Positive response

​
id
string<uuid>
required
​
sourceId
string
required
Maximum string length: 255
​
name
string | null
required
Maximum string length: 255
​
description
string | null
required
Maximum string length: 1000
​
campaignId
string<uuid>
required
​
phoneNumberId
integer | null
required
Required range: -2147483648 <= x <= 2147483647
​
dealType
enum<string>
required
Available options:
CPA,
CPL
​
sourceType
enum<string>
required
Available options:
outbound,
inbound
​
pricingModel
enum<string>
required
Available options:
flat_rate,
percentage,
dynamic,
static,
duration
​
payout
string | null
required
​
commissionPerSale
string | null
required
​
leadCost
string | null
required
​
durationThreshold
string | null
required
​
enabled
boolean | null
required
​
createdAt
any
required
​
updatedAt
any
required
​
campaignName
string | null
required