Campaign data model
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier for the campaign |
created_at | string (date-time) | No | When the campaign was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | When the campaign was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
name | string | No | Campaign nametitle |
type | string | No | Campaign type (e.g., regular, automation, ab_test) |
status | enum | No | Campaign status Values: DRAFT, SCHEDULED, SENDING, SENT, CANCELLED, PAUSED, ARCHIVED, OTHER |
list_ids | string[] | No | Associated listaudience IDs |
subject_line | string | No | Email subject line |
preview_text | string | No | Email preview text |
from_name | string | No | Sender name |
from_email | string | No | Sender email address |
reply_to_email | string | No | Reply-to email address |
send_at | string (date-time) | No | Scheduled send time (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
metadata | MarketingMetadata[] | No | |
metadata[].id | string | No | |
metadata[].slug | string | No | |
metadata[].value | object | No | |
metadata[].namespace | string | No | |
metadata[].format | enum | No | Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL |
metadata[].extra_data | object | No |
Are we missing anything? Let us know
Was this page helpful?