Contact List — Opt-in Email¶
Opt-in email entity for a contact list.
Endpoint¶
All verbs: /contact_list/<list>/optin_email
GET /contact_list/<list>/optin_email¶
Payload: No payload.
Returns: The opt-in email.
POST /contact_list/<list>/optin_email¶
Note
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 (domain must be enabled as 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 file |
Returns: The contact list and new opt-in email.
PUT /contact_list/<list>/optin_email¶
Same payload as POST.
Returns: The contact list and edited opt-in email.