Lead
/api/v1/marketing/leadsA marketing lead with a score and lifecycle status.
listgetcreateupdatedeleteSchema
| Field | Type | Notes |
|---|---|---|
| id* | uuid | Server-assigned ULID with type prefix (e.g. per_…). |
| tenant_id* | string | Tenant scope — auto-stamped from the caller's JWT. |
| app_id | string | App scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present. |
| created_at* | date-time | Server stamp. |
| updated_at* | date-time | Server stamp; updated on every patch. |
| created_by | uuid | Person id from the caller's JWT (sub). |
| updated_by | uuid | Person id from the last writer's JWT (sub). |
| source | string | Provenance tag — defaults to 'edm'. |
| source_type | enum | frontend | backend | server | system | apiWhere the write originated. Defaults to 'api'. |
| is_deleted | boolean | Soft-delete flag. Excluded from default list queries. |
| deleted_at | date-time | Stamped when soft-deleted; null otherwise. |
| deleted_by | uuid | Person id who soft-deleted; null otherwise. |
| schema_version | number | Document schema version. Bumped on incompatible writes. |
| name* | string | Lead name. |
| Lead email address. | ||
| source | string | Lead source (e.g. website_form). |
| score | number | Lead score. |
| status | enum | new | qualified | nurturing | converted | lostLead lifecycle status. |
| contact_id | string | Linked contact ID. |
| account_id | string | Linked account ID. |
| campaign_id | string | Originating campaign ID. |
| assigned_to | string | User ID of the assignee. |
| notes | string | Free-form notes. |
API
Loading manifest…