Scope leads:read for reads · leads:write for changes
Operations
| GET | /v1/leads | List — see list |
| POST | /v1/leads | Create — see create |
| GET | /v1/leads/{id} | Read — see get |
| PATCH | /v1/leads/{id} | Update — see update |
| DELETE | /v1/leads/{id} | Delete — see delete |
Minimal create
curl -X POST https://api2.djcsystem.com/v1/leads \
-H "Authorization: Bearer $DJC_TOKEN" -H "Content-Type: application/json" \
-d '{ "name": "…" }'Fields
Fields you may send on create. Updatable marks fields accepted by PATCH. Anything not listed is server-owned or hidden.
| Field | Type | On create | Updatable |
|---|---|---|---|
name | string | required | yes |
phone | string | optional | yes |
email | string | optional | yes |
source | string | optional | yes |
status | string | optional | yes |
remarks | string | optional | yes |
campaignName | string | optional | yes |
birthday | string | optional | yes |
type | string | optional | yes |
tags | array<string> | optional | yes |
labels | array<object> | optional | yes |
customData | record<string,string> | optional | yes |
field_data | array<object> | optional | yes |
converted | boolean | optional | yes |
whatsappFlowId | string | optional | yes |
assignedTo1 | string | optional | yes |
assignedTo2 | string | optional | yes |
assignedTo3 | string | optional | yes |
assignedTo4 | string | optional | yes |
assignedTo5 | string | optional | yes |
warriors | array<string> | optional | yes |
Filters & sorting
| Filterable | statussourcephoneemailconvertedwhatsappFlowIdassignedTo1campaignName |
| Sortable | created |
| Default order | created:desc |
Good to know
- Search for an existing lead by phone (`filter[phone]=6012…`, digits only, country code first) before creating one.
- `tags` is a flat list of strings; `labels` are the coloured chips shown in the Leads table.