Contact List — Contact¶
A contact is an entity within a contact list holding data necessary to generate and send messages.
Endpoints¶
| Method | URL |
|---|---|
GET |
/contact_list/<list>/contact/<contact> |
POST |
/contact_list/<list>/contact |
PUT |
/contact_list/<list>/contact/<contact> |
DELETE |
/contact_list/<list>/contact/<contact> |
GET /contact_list/<list>/contact/<contact>¶
Payload: No payload.
Returns: The contact.
POST /contact_list/<list>/contact¶
Note
A contact must have at least a phone number or an email.
Lists without double opt-in cannot have contacts with PENDING subscription status.
Custom fields are always optional.
| Parameter | Type | Description |
|---|---|---|
email |
string | Contact email |
telephone |
string | Contact telephone number |
subscription_status |
string | One of SUBSCRIBED, PENDING, UNSUBSCRIBED |
bouncing |
boolean | Whether the contact is marked as not receiving payloads |
custom[custom_field_id] |
string | Value for a custom field (may appear multiple times for different IDs) |
Returns: The new contact.
PUT /contact_list/<list>/contact/<contact>¶
Same payload as POST.
Returns: The edited contact.
DELETE /contact_list/<list>/contact/<contact>¶
Payload: No payload.
Returns: The deleted contact.