Campaign
/api/v1/marketing/campaignsA marketing campaign across one or more channels.
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 | Campaign name. |
| type | enum | email | social | content | event | paid | organic | multi_channelCampaign channel type. |
| status | enum | draft | active | paused | completed | cancelledCampaign lifecycle status. |
| start_date | date-time | ISO 8601 campaign start date. |
| end_date | date-time | ISO 8601 campaign end date. |
| budget | number | Allocated campaign budget. |
| spent | number | Amount spent so far. |
| goals | json | Campaign goals. |
| owner_id | string | User ID of the campaign owner. |
API
Loading manifest…