{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "<string>",
"phone": "<string>",
"company_name": "<string>",
"status": "<string>",
"customer_type": "individual",
"industry": "<string>",
"source": "<string>",
"assigned_to_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"priority": "urgent",
"probability": 123,
"value": 123,
"currency": "<string>",
"expected_close_date": "2023-12-25",
"tags": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"statusCode": 403,
"message": "API key missing required scope(s): conversations:read",
"error": "Forbidden"
}{
"statusCode": 403,
"message": "API key missing required scope(s): conversations:read",
"error": "Forbidden"
}{
"statusCode": 403,
"message": "API key missing required scope(s): conversations:read",
"error": "Forbidden"
}{
"statusCode": 403,
"message": "API key missing required scope(s): conversations:read",
"error": "Forbidden"
}Update a lead or move its stage
Send only the fields you are changing. Moving a lead through the pipeline is a
status update — set it to the target stage’s key.
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "<string>",
"phone": "<string>",
"company_name": "<string>",
"status": "<string>",
"customer_type": "individual",
"industry": "<string>",
"source": "<string>",
"assigned_to_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"priority": "urgent",
"probability": 123,
"value": 123,
"currency": "<string>",
"expected_close_date": "2023-12-25",
"tags": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"statusCode": 403,
"message": "API key missing required scope(s): conversations:read",
"error": "Forbidden"
}{
"statusCode": 403,
"message": "API key missing required scope(s): conversations:read",
"error": "Forbidden"
}{
"statusCode": 403,
"message": "API key missing required scope(s): conversations:read",
"error": "Forbidden"
}{
"statusCode": 403,
"message": "API key missing required scope(s): conversations:read",
"error": "Forbidden"
}Authorizations
Your workspace API key. Create one in Settings → API Keys; the plaintext value is shown once and never again.
Keys are scoped. A key needs conversations:send to send, conversations:read to
read threads and messages, templates:read to list templates, and channels:read
to list channels. A key missing the scope for an endpoint gets 403.
The CRM endpoints use the same resource:action form: leads:read, leads:create,
leads:update, leads:delete, customers:read, customers:create,
customers:update, customers:delete, customers:manage.
Several resources have no scope of their own and borrow one:
| Resource | Governed by |
|---|---|
| Contacts | customers:* |
| Activities | customers:* for customer activities, leads:* for lead activities |
| Tags | customers:read to list, customers:manage to change |
| Pipeline stages | leads:* |
| Quick replies | quick-replies:read / quick-replies:write |
| WhatsApp groups | wa-groups:manage |
Grant only what the integration needs — a key that only sends notifications should
hold conversations:send and nothing else.
Your workspace UUID. Required on every request in addition to x-api-key.
It does not select the workspace — data access is always scoped to the workspace that owns the API key, and a mismatched value cannot read anyone else's data.
Path Parameters
Body
All fields optional on update; send only what changes.
Target stage key.
individual, business urgent, high, medium, low Response
The updated lead.
The lead's stage key — see GET /v1/lead-stages.
individual, business Where the lead came from, e.g. whatsapp or website.
urgent, high, medium, low Percentage, 0–100.
Deal size.