PUT
https://emailoctopus.com/api/1.5/lists/:listId/contacts/:memberId
Update a contact of a list.
| Route parameters |
|
listId (string)
|
The ID of the list.
|
|
memberId (string)
|
The ID of the list contact, or an MD5 hash of the lowercase version of the list contact’s email address.
|
| Parameters |
|
api_key (string)
|
Your API key.
|
|
email_address (string, optional)
|
The new email_address for the contact.
|
|
fields (object, optional)
|
An object containing key/value pairs of field values, using the field's tag as the key.
|
|
status (string)
|
The new status of the contact (SUBSCRIBED, UNSUBSCRIBED or PENDING).
|
| 200 (Success) Returns |
|
Details of the updated contact:
|
id (string)
|
The identifier of the contact.
|
|
email_address (string)
|
The email address of the contact.
|
|
fields (object)
|
An object containing key/value pairs of field values, using the field's tag as the key.
|
|
status (string)
|
The status of the contact (SUBSCRIBED, UNSUBSCRIBED or PENDING).
|
|
created_at (string)
|
When the contact was created, in ISO 8601 format.
|
|
| Non-200 (Error) Returns |
|
Details of the error:
|
code (string)
|
The error code.
|
|
message (string)
|
A description of the error.
|
|
| Method-specific Error Codes |
|
MEMBER_NOT_FOUND
|
The contact could not be found.
|
| API-wide Error Codes |
|
INVALID_PARAMETERS
|
Parameters are missing or invalid.
|
|
API_KEY_INVALID
|
Your API key is invalid.
|
|
UNAUTHORISED
|
You're not authorised to perform that action.
|
|
NOT_FOUND
|
The requested endpoint does not exist.
|
|
UNKNOWN
|
An unknown error has occurred.
|
| Example Request |
{
"api_key": "00000000-0000-0000-0000-000000000000",
"email_address": "joe@bloggs.com",
"fields": {
"FirstName": "Joe",
"LastName": "Bloggs"
},
"status": "SUBSCRIBED"
}
|
| Example Response |
{
"id": "00000000-0000-0000-0000-000000000000",
"email_address": "john.doe@example.com",
"fields": {
"FirstName": "John",
"LastName": "Doe"
},
"status": "SUBSCRIBED",
"created_at": "2020-03-28T00:00:00+00:00"
}
|