This endpoint will add a customer to a list, or if the customer already exists, will update the record of that customer with the supplied data.
POST /lists/LIST_ID/contacts/
Payload Specification
Param Name | Required | Type | Description |
---|---|---|---|
email | Yes | String | The email address of the customer |
first_name | No | String | The first name of the customer |
last_name | No | String | The last name of the customer |
phone | No | String | A phone number for the customer. |
timezone | No | String | Timezone of customer, should be in list of TZ database names |
age | No | Number | Age of customer |
gender | No | "m" or "f" | Gender of customer. |
language | No | String | Two letter code of customers language |
address1 | No | String | First line of address for customer |
address2 | No | String | Second line of address for customer |
city | No | String | City where customer lives. |
state | No | String | State where customer lives. |
postal_code | No | String | Postal code of customer's address |
country | No | String | Country where customer lives |
birthdate | No | String | ISO formated date when the customer was born. |
Any additional params will be treated as strings and added to the
custom_fields
of the list contact.
All specified parameters will update the customer's record for all applications within Rejoiner, not just for the given list.
{
"email": "[email protected]",
"first_name": "Test",
"age": "28",
"another_custom_field": "abc"
}
On a successful request, the response will return a structured response representing the entire list contact.
{
"customer": {
"id": "CUSTOMER_ID",
"email": "[email protected]",
"first_name": "Test"
},
"custom_fields": {
"existing_custom_field": "xyz",
"another_custom_field": "abc"
}
}
Newly added contacts will return a successful response with status code 201
.
If the contact is already on the list a successful response with status code 200
will be returned.