POST https://emailoctopus.com/api/1.5/lists
Create a new list.
| Parameters |
|
api_key (string)
|
Your API key.
|
|
name (string)
|
The name of the new list.
|
| 200 (Success) Returns |
|
Details of the new list:
|
id (string)
|
The identifier of the list.
|
|
name (string)
|
The name of the list.
|
|
double_opt_in (boolean)
|
If double opt-in has been enabled on the list.
|
|
fields (array)
|
|
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.
|
|
|
counts (struct)
|
The summary counts of the list:
|
pending (integer)
|
The number of pending contacts in the list.
|
|
subscribed (integer)
|
The number of subscribed contacts in the list.
|
|
unsubscribed (integer)
|
The number of unsubscribed contacts in the list.
|
|
|
created_at (string)
|
When the list 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 |
|
None.
|
| 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",
"name": "Foo"
}
|
| Example Response |
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "Foo",
"created_at": "2020-08-10T00:00:00+00:00"
}
|