VUZDevelopers

Transition a client to a new lifecycle stage

POST
/crm/clients/{clientId}/lifecycle/transition

Moves the client to the specified lifecycle stage and records the change in the stage history log.

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.

Response Body

application/json

curl -X POST "https://example.com/crm/clients/string/lifecycle/transition" \  -H "Content-Type: application/json" \  -d '{    "stage": "prospect"  }'
{  "currentStage": "lead",  "crmScore": 0,  "lastInteractionAt": "2019-08-24T14:15:22Z",  "stageHistory": [    {      "id": "string",      "fromStage": "lead",      "toStage": "lead",      "reason": "string",      "trigger": "manual",      "changedAt": "2019-08-24T14:15:22Z",      "userName": "string"    }  ]}