API DOCUMENTATION

Home > API documentation

You need to add parameter api_token=YOUR_API_TOKEN to each request to the API system
Example: https://marketing.desoftmail.com/api/v1/lists?api_token=YOUR_API_TOKEN

LISTS

HTTP method Endpoint Function
POST /api/v1/lists New list

Parameters

$name
List's name
$from_email
Default From email address
$from_name
Default From name
$default_subject   optional
Default email subject
divider
Contact information
$contact[company]
Name
$contact[state]
State / Province / Region
$contact[address_1]
Address 1
$contact[address_2]
Address 2
$contact[city]
City
$contact[zip]
Zip / Postal code
$contact[phone]
Phone
$contact[country_id]
Country id
$contact[email]
Email
$contact[url]   optional
Home page
$subscribe_confirmation
Send subscription confirmation email (Double Opt-In)
$send_welcome_email
Send a final welcome email
$unsubscribe_notification
Send unsubscribe notification to subscribers
$send_welcome_email
Send a final welcome email

Returns

Creation messages in json

Example:

curl -X POST -H "accept:application/json" -G \
https://marketing.desoftmail.com/api/v1/lists? \
-d api_token=8ZJoezN3hTijM9uB583vzI3kOh2ZpCAiNzKs6cXPtYFmUUlf6GBUWgnVKZT4 \
-d name=List+1 \
-d from_email=admin@abccorp.org \
-d from_name=ABC+Corp. \
-d default_subject=Welcome+to+ABC+Corp. \
-d contact[company]=ABC+Corp. \
-d contact[state]=Armagh \
-d contact[address_1]=14+Tottenham+Court+Road+London+England \
-d contact[address_2]=44-46+Morningside+Road+Edinburgh+Scotland+EH10+4BF \
-d contact[city]=Noname \
-d contact[zip]=80000 \
-d contact[phone]=123+456+889 \
-d contact[country_id]=1 \
-d contact[email]=info@abccorp.org \
-d contact[url]=http://www.abccorp.org \
-d subscribe_confirmation=1 \
-d send_welcome_email=1 \
-d unsubscribe_notification=1
GET /api/v1/lists Get information about all lists

Returns

List of all user's mail lists in json

Example:

curl -X GET -H "accept:application/json" -G \
https://marketing.desoftmail.com/api/v1/lists? \
-d api_token=8ZJoezN3hTijM9uB583vzI3kOh2ZpCAiNzKs6cXPtYFmUUlf6GBUWgnVKZT4
GET /api/v1/lists/{uid} Get information about a specific list

Returns

All list informations in json

Example:

curl -X GET -H "accept:application/json" -G \
https://marketing.desoftmail.com/api/v1/lists/{uid}? \
-d api_token=8ZJoezN3hTijM9uB583vzI3kOh2ZpCAiNzKs6cXPtYFmUUlf6GBUWgnVKZT4

CAMPAIGNS

HTTP method Endpoint Function
GET /api/v1/campaigns Get information about all campaigns

Returns

List of all user's campaigns in json

Example:

curl -X GET -H "accept:application/json" -G \
https://marketing.desoftmail.com/api/v1/campaigns? \
-d api_token=8ZJoezN3hTijM9uB583vzI3kOh2ZpCAiNzKs6cXPtYFmUUlf6GBUWgnVKZT4
GET /api/v1/campaigns/{uid} Get information about a specific campaign

Returns

Campaign's information in json

Example:

curl -X GET -H "accept:application/json" -G \
https://marketing.desoftmail.com/api/v1/campaigns/{uid}? \
-d api_token=8ZJoezN3hTijM9uB583vzI3kOh2ZpCAiNzKs6cXPtYFmUUlf6GBUWgnVKZT4

SUBSCRIBERS

HTTP method Endpoint Function
GET /api/v1/lists/{list_uid}/subscribers Display list's subscribers

Parameters

$list_uid
List's uid
$open   optional - default: all
yes - opened some campaigns
no - not opened any campaign
$click   optional - default: all
yes - clicked some campaigns
no - not clicked any campaign
$per_page   optional - default: 25
Number of subscribers per page
$page
Page number

Returns

List of all list's subscribers in json

Example:

curl -X GET -H "accept:application/json" -G \
https://marketing.desoftmail.com/api/v1/lists/{list_uid}/subscribers? \
-d api_token=8ZJoezN3hTijM9uB583vzI3kOh2ZpCAiNzKs6cXPtYFmUUlf6GBUWgnVKZT4 \
-d per_page=20 \
-d page=1
GET /api/v1/lists/{list_uid}/subscribers/{uid} Get information about a specific subscriber

Parameters

$uid
Subsciber's uid or email

Returns

All subscriber information in json

Example:

curl -X GET -H "accept:application/json" -G \
https://marketing.desoftmail.com/api/v1/lists/{list_uid}/subscribers/{uid}? \
-d api_token=8ZJoezN3hTijM9uB583vzI3kOh2ZpCAiNzKs6cXPtYFmUUlf6GBUWgnVKZT4
GET /api/v1/subscribers/email/{email} Find subscribers with email

Parameters

$email
Subsciber's email

Returns

All subscribers with the email

Example:

curl -X GET -H "accept:application/json" -G \
https://marketing.desoftmail.com/api/v1/subscribers/email/{email}? \
-d api_token=8ZJoezN3hTijM9uB583vzI3kOh2ZpCAiNzKs6cXPtYFmUUlf6GBUWgnVKZT4
POST /api/v1/lists/{list_uid}/subscribers/store Create subscriber for a mail list

Parameters

$EMAIL
Subscriber's email
$[OTHER_FIELDS...]   optional
All subscriber's other fields: FIRST_NAME (?), LAST_NAME (?),... (depending on the list fields configuration)

Returns

Creation messages in json

Example:

curl -X POST -H "accept:application/json" -G \
https://marketing.desoftmail.com/api/v1/lists/{list_uid}/subscribers/store? \
-d api_token=8ZJoezN3hTijM9uB583vzI3kOh2ZpCAiNzKs6cXPtYFmUUlf6GBUWgnVKZT4 \
-d EMAIL=test@gmail.com \
-d FIRST_NAME=Marine \
-d LAST_NAME=Joze
PATCH /api/v1/lists/{list_uid}/subscribers Update subscriber for a mail list

Parameters

$EMAIL
Subscriber's email
$[OTHER_FIELDS...]   optional
All subscriber's other fields: FIRST_NAME (?), LAST_NAME (?),... (depending on the list fields configuration)

Returns

Update messages in json

Example:

curl -X PATCH -H "accept:application/json" -G \
https://marketing.desoftmail.com/api/v1/lists/{list_uid}/subscribers/{uid}/update? \
-d api_token=8ZJoezN3hTijM9uB583vzI3kOh2ZpCAiNzKs6cXPtYFmUUlf6GBUWgnVKZT4 \
-d EMAIL=test@gmail.com \
-d FIRST_NAME=Marine \
-d LAST_NAME=Joze
PATCH /api/v1/lists/{list_uid}/subscribers/{uid}/subscribe Subscribe a subscriber

Parameters

$list_uid
List's uid
$uid
Subsciber's uid

Returns

Result messages in json

Example:

curl -X PATCH -H "accept:application/json" -G \
https://marketing.desoftmail.com/api/v1/lists/{list_uid}/subscribers/{uid}/subscribe? \
-d api_token=8ZJoezN3hTijM9uB583vzI3kOh2ZpCAiNzKs6cXPtYFmUUlf6GBUWgnVKZT4
PATCH /api/v1/lists/{list_uid}/subscribers/{uid}/unsubscribe Unsubscribe a subscriber

Parameters

$list_uid
List's uid
$uid
Subsciber's uid

Returns

Result messages in json

Example:

curl -X PATCH -H "accept:application/json" -G \
https://marketing.desoftmail.com/api/v1/lists/{list_uid}/subscribers/{uid}/unsubscribe? \
-d api_token=8ZJoezN3hTijM9uB583vzI3kOh2ZpCAiNzKs6cXPtYFmUUlf6GBUWgnVKZT4
DELETE /api/v1/lists/{list_uid}/subscribers/{uid}/delete Delete a subscriber

Parameters

$list_uid
List's uid
$uid
Subsciber's uid

Returns

Result messages in json

Example:

curl -X DELETE -H "accept:application/json" -G \
https://marketing.desoftmail.com/api/v1/lists/{list_uid}/subscribers/{uid}/delete? \
-d api_token=8ZJoezN3hTijM9uB583vzI3kOh2ZpCAiNzKs6cXPtYFmUUlf6GBUWgnVKZT4

FILE

HTTP method Endpoint Function
POST /api/v1/file/upload Upload file(s) to customer's storage

Parameters

$file_url
File url
$subdirectory   optional - default: user root directory
Custom subdirectory

Returns

Upload result message

Example:

curl -X POST -H "accept:application/json" -G \
https://marketing.desoftmail.com/api/v1/file/upload? \
-d api_token=8ZJoezN3hTijM9uB583vzI3kOh2ZpCAiNzKs6cXPtYFmUUlf6GBUWgnVKZT4  \
-d files='[{"url":"http://demo.acellemail.com/images/logo_big.png","subdirectory":"path/to/file"},{"url":"http://demo.acellemail.com/images/logo_big.png","subdirectory":"path/to/file2"}]'