EmailOctopus logo

API > Lists > Update Contact of List

PUT https://emailoctopus.com/api/1.6/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.
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:

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.
tags (array) An array of tags associated with the contact.
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.
EXCEEDS_LIST_TAG_LIMIT Creating these new tags would mean you exceed the maximum number of tags allowed per list.
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",
        "Birthday": "2000-12-20"
    },
    "tags": {
        "vip": true,
        "tagToRemove": false
    },
    "status": "SUBSCRIBED"
}

                        
                    
Example response
                        
                                {
    "id": "00000000-0000-0000-0000-000000000000",
    
    "email_address": "john.doe@example.com",
    
    "fields": {
        "FirstName": "John",
        "LastName": "Doe",
        "Birthday": "2000-12-20"
    },
    "tags": ["vip"],
    "status": "SUBSCRIBED",
    "created_at": "2022-12-09T00:00:00+00:00"
}

                        
                    
Code sample
copy