Create a list
POST
/api/v1/lists
The list starts with the fields EMAIL, FIRST_NAME and LAST_NAME.
Request body application/x-www-form-urlencoded
name
string
required
from_email
string (email)
required
Default From address of its campaigns.
from_name
string
required
Default From name of its campaigns.
remind_message
string
Why a contact gets the emails, shown in their footer.
subscribe_confirmation
boolean
Ask new contacts to confirm their address (double opt-in).
send_welcome_email
boolean
Send a welcome email to a new contact.
unsubscribe_notification
boolean
Send a goodbye email to a contact who unsubscribes.
email_subscribe
string
Addresses, separated by commas, told of each new contact.
email_unsubscribe
string
Addresses, separated by commas, told of each contact who unsubscribes.
email_daily
string
Addresses, separated by commas, sent a daily summary.
Responses
200
The list was created.
401
The token is missing or wrong (
Unauthenticated.), or its user may not act on
this object (Unauthorized). Without the Accept: application/json header, a
missing or wrong token answers with a redirect to the sign-in page instead.
403
A field is missing or wrong: each field that failed, with its messages. Or the
token's user may not create a list:
{"status": 0, "message": "You have exceeded the service quota"}.
422
The plan allows no more lists.
Create a list
1
2
3
4
5
6
7
8
9
10
11
12
13
curl -X POST 'https://your-domain/api/v1/lists' \
-H "Accept: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
--data-urlencode 'name=Newsletter' \
--data-urlencode 'from_email=newsletter@example.com' \
--data-urlencode 'from_name=Example Team' \
--data-urlencode 'remind_message=You signed up at example.com.' \
--data-urlencode 'subscribe_confirmation=1' \
--data-urlencode 'send_welcome_email=1' \
--data-urlencode 'unsubscribe_notification=0' \
--data-urlencode 'email_subscribe=owner@example.com' \
--data-urlencode 'email_unsubscribe=owner@example.com' \
--data-urlencode 'email_daily=owner@example.com'
1
2
3
4
5
6
$client = new Acelle\Client('https://your-domain/api/v1', 'YOUR_API_TOKEN');
$client->list()->create([
'name' => 'Newsletter',
'from_email' => 'newsletter@example.com',
'from_name' => 'Example Team',
]);
Response
{
"status": 1,
"message": "List was successfully created",
"list_uid": "6adaabbf98847"
}