/api/v1/marketing/emailsA marketing email blast with delivery and engagement rates.
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. |
| subject* | string | Email subject line. |
| campaign_id | string | Associated campaign ID. |
| status | enum | draft | scheduled | sent | bounced | cancelledEmail lifecycle status. |
| template_id | string | Email template ID. |
| sent_at | date-time | ISO 8601 send timestamp. |
| scheduled_at | date-time | ISO 8601 scheduled send time. |
| recipient_count | number | Number of recipients. |
| open_rate | number | Open rate (0–1). |
| click_rate | number | Click-through rate (0–1). |
| bounce_rate | number | Bounce rate (0–1). |
| author_id | string | User ID of the author. |
API
Loading manifest…