Skip to main content
PATCH
/
v2
/
customers
/
{id}
/
custom-fields
/
{customFieldId}
Update customer custom field value
curl --request PATCH \
  --url https://api.carecycle.ai/v2/customers/{id}/custom-fields/{customFieldId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "textValue": "<string>",
  "numberValue": "<string>",
  "booleanValue": true,
  "dateValue": "<string>",
  "selectValue": "<string>",
  "multiSelectValue": [
    "<string>"
  ]
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "fieldDefinitionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "recordId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "recordType": "customers",
  "textValue": "<string>",
  "numberValue": "<string>",
  "booleanValue": true,
  "dateValue": "<string>",
  "selectValue": "<string>",
  "multiSelectValue": [
    "<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

Customer ID

​
customFieldId
string<uuid>
required

Custom field value ID

Body

application/json

PATCH /v2/customers/:id/custom-fields/:customFieldId Request body

​
textValue
string | null
​
numberValue
string | null
​
booleanValue
boolean | null
​
dateValue
string | null
​
selectValue
string | null
​
multiSelectValue
string[] | null

Response

PATCH /v2/customers/:id/custom-fields/:customFieldId Positive response

​
id
string<uuid>
required
​
createdAt
string | null
required
​
updatedAt
string | null
required
​
fieldDefinitionId
string<uuid>
required
​
recordId
string<uuid>
required
​
recordType
enum<string>
required
Available options:
customers
​
textValue
string | null
required
​
numberValue
string | null
required
​
booleanValue
boolean | null
required
​
dateValue
string | null
required
​
selectValue
string | null
required
​
multiSelectValue
string[] | null
required