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. |
tags (object, optional) |
An object containing key/value pairs, where the key is the tag name and the value is true to add the tag or false to remove it. Tags that are not referenced in the object will not be updated.
|
status (string, optional) |
The new status of the contact: SUBSCRIBED , UNSUBSCRIBED or PENDING .
|
200 (success) returns | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Details of the updated contact:
|
Non-200 (error) returns | ||||
---|---|---|---|---|
Details 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 | |
---|---|
|
Example response | |
---|---|
|
Code sample
|
|
---|---|
curl -X PUT
-H "Content-Type: application/json" -d '{"api_key":"00000000-0000-0000-0000-000000000000","email_address":"joe@bloggs.com","fields":{"FirstName":"Joe","LastName":"Bloggs","Birthday":"2000-12-20"},"tags":{"tagToAdd":true,"tagToRemove":false},"status":"SUBSCRIBED"}' https://emailoctopus.com/api/1.6/lists/00000000-0000-0000-0000-000000000000/contacts/00000000-0000-0000-0000-000000000000
|