EmailOctopus logo

API > Lists > Create Contact Of A List

POST https://emailoctopus.com/api/1.6/lists/:listId/contacts

Create a contact of a list.

Parameters
api_key (string) Your API key.
email_address (string) The email address of the contact.
fields (object, optional) An object containing key/value pairs of field values, using the field's tag as the key.
tags (array, optional) An array of tags to add to the contact.
status (string, optional) The initial status of the contact: SUBSCRIBED, UNSUBSCRIBED or PENDING. If omitted, the value will default to PENDING for lists with double opt-in enabled, or SUBSCRIBED for lists without.
200 (success) returns

Details of the new 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.
last_updated_at (string) When the contact was last updated, 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_EXISTS_WITH_EMAIL_ADDRESS A contact already exists with the supplied email address.
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"],
    "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": "2024-11-06T00:00:00+00:00",
    "last_updated_at": "2024-11-07T16:26:05+00:00"
}

                        
                    
Code sample
copy