Update the CRM profile for a client

Updates fields such as lifecycle stage, lead source, preferred communication channel, and do-not-contact flag.

Authorization

X-Api-Key<token>

Business API key, e.g. vuz_ab12cdef... Created via Settings → Integrations → API Keys. Unlike partner keys, a public API key's STRING does not encode its environment — isolation instead comes from a completely separate sandbox database: a key minted on the Sandbox server (above) only ever reads/writes sandbox data and can never see or affect production, regardless of what the key looks like.

In: header

Path Parameters

clientId*string

Client UUID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

lifecycleStage?string

Lifecycle stage for this client

Value in

"lead"
"prospect"
"active"
"at_risk"
"churned"

leadSource?string

Lead source — how this client was acquired

Lengthlength <= 255

preferredChannel?string

Preferred communication channel for this client

Value in

"email"
"whatsapp"
"sms"
"phone"
"telegram"

doNotContact?boolean

When true, suppress all outbound automated communications to this client

Response Body

`application/json`

curl -X PATCH "https://example.com/crm/clients/string/profile" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "string",  "clientId": "string",  "businessId": "string",  "lifecycleStage": "lead",  "crmScore": 72,  "lastInteractionAt": "2019-08-24T14:15:22Z",  "leadSource": "string",  "preferredChannel": "email",  "doNotContact": true,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}