API Reference

A mail list is a collection of email addresses used by an individual or an organization to send marketing material to multiple recipients. You can have different lists of different group of contacts

Make a POST request to the /list resource along with your desired list details to create. On success, a unique List UID key is returned for the newly created list, which is used as a reference key for interacting with it.


Parameters


api_token string
Your API token. You can find it in your API main page when logged in.


name string
List's name


from_email email
Default From email address


from_name string
Default From name


default_subject string
Default email subject


contact[company] string
Company name


contact[state] string
State / Province / Region


contact[address_1] string
Address 1


contact[address_2] string
Address 2


contact[city] string
City


contact[zip] string
Zip / Postal code


contact[phone] string
Phone


contact[country_id] string
Country id


contact[email] email
Email


contact[url] url
Home page


subscribe_confirmation string
Send subscription confirmation email (Double Opt-In)


send_welcome_email string
Send a final welcome email


unsubscribe_notification string
Send unsubscribe notification to subscribers


send_welcome_email string
Send a final welcome email

$client = new Acelle\Client(
    'https://app.sastamail.com/api/v1',
    '*|api_token|*'
);
$client->list()->create([
    'name' => 'List+1',
    'from_email' => '[email protected]',
    'from_name' => 'ABC+Corp.',
    'default_subject' => 'Welcome+to+ABC+Corp.',
    'contact' => [
        'company' => 'ABC+Corp.',
        'state' => 'Armagh',
        'address_1' => '14+Tottenham+Court+Road+London+England',
        'address_2' => '44-46+Morningside+Road+Edinburgh+Scotland',
        'city' => 'Noname',
        'zip' => '80000',
        'phone' => '123+456+889',
        'country_id' => '1',
        'email' => '[email protected]',
        'url' => 'http://www.abccorp.org',                
    ],
    'subscribe_confirmation' => '1',
    'send_welcome_email' => '1',
    'unsubscribe_notification' => '1',
]);
{
    "status": 1,
    "message": "List was successfully created",
    "list_uid": "5fc9e55410e10"
}