Contact List¶
Contact list entity. A container for contacts used in Campaigns and Transactional Sends.
Endpoints¶
| Method | URL |
|---|---|
GET |
/contact_list/<list> |
POST |
/contact_list |
PUT |
/contact_list/<list> |
DELETE |
/contact_list/<list> |
GET /contact_list/<list>¶
Payload: No payload.
Returns: The contact list and a dictionary of contact counts per subscription state.
POST /contact_list¶
| Parameter | Type | Description |
|---|---|---|
name |
string | The contact list name |
double_optin |
boolean | Whether new contacts require double opt-in |
shared_with_children |
boolean | Share write access with hierarchical child users |
read_shared_with_children |
boolean | Share usage access with hierarchical child users |
unsubscribe_message |
string | Message shown to contacts who unsubscribe |
Returns: The new contact list.
PUT /contact_list/<list>¶
Same payload as POST.
Returns: The edited contact list.
DELETE /contact_list/<list>¶
Payload: No payload.
Returns: The deleted contact list.