Campaign — Email¶
Campaign email entity. This is the email payload sent when the campaign runs.
Endpoint¶
All verbs: /campaign/<campaign>/email
POST /campaign/<campaign>/email¶
Note
The payload must be sent as multipart/form-data to accommodate the attachment parameter.
| Parameter | Type | Description |
|---|---|---|
header_from_name |
string | Human-readable sender name |
header_from |
string | Sender email. The domain must be enabled as a sending domain. |
subject |
string | Message subject |
message |
string | Message HTML |
block_editor_content |
string (optional) | JSON for block editor content (Froala only) |
attachment |
file (optional) | Attachment, submitted as <input type="file"> |
Returns: The edited campaign and email.
PUT /campaign/<campaign>/email¶
Same payload as POST.
Returns: The edited campaign and email.
DELETE /campaign/<campaign>/email¶
Payload: No payload.
Returns: The deleted email.