EmailOctopus logo

API > Lists > Create list field

POST https://emailoctopus.com/api/1.5/lists/:listId/fields

Create list field

Parameters
api_key (string) Your API key.
label (string) A human readable label for the field.
tag (alphanumeric string) The identifier used to reference the field in your emails.
type (string) The type of the field - can be NUMBER or TEXT. Cannot be changed after the field is created.
fallback (string, optional) A default value for the field, used when there is no other value available.
200 (success) returns

Details of the new field:

tag (string) The identifier used to reference the field in your emails.
type (string) The type of the field - can be NUMBER or TEXT.
label (string) A human readable label for the field.
fallback (string) A default value for the field, used when there is no other value available.
Non-200 (error) returns

Details of the error:

code (string) The error code.
message (string) A description of the error.
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",
    "label": "What is your hometown?",
    "tag": "Hometown",
    "type": "TEXT",    "fallback": "Unknown"
}

                    
                
Example response
                    
                        {
    "label": "What is your hometown?",
    "tag": "Hometown",
    "type": "TEXT",
    "fallback": "Unknown"
}

                    
                
Code sample
copy
curl -X POST -H "Content-Type: application/json" -d '{"api_key":"00000000-0000-0000-0000-000000000000","label":"What is your hometown?","tag":"Hometown","type":"TEXT","fallback":"Unknown"}' https://emailoctopus.com/api/1.5/lists/00000000-0000-0000-0000-000000000000/fields