Developers

API documentation

Everything Emboxia exposes so you can wire it into your own systems: lists, campaigns, contacts and delivery notifications.

Base URL

https://app.emboxia.com/api/v1

Authentication

Add the api_token parameter to every request. You will find it in your panel, under “Campaign API”.

Authentication

POST/api/v1/user/loginGet API token using email and password

Get API token using email and password

Parameters

email: User's email
password: User's password

Returns

API Token

Example

curl -X POST -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/user/login \
-d email=user@example.com \
-d password=yourpassword

POST/api/v1/login-tokenGenerate one time login token

Generate one time login token

Returns

Token string

User can login by visiting the following URL:
https://app.emboxia.com/login/token/*|token_string|*

Example

curl -X POST -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/login-token \
-d api_token=TU_TOKEN_DE_API

LISTS

POST/api/v1/listsNew list

New list

Parameters

$name: List's name
$from_email: Default From email address
$from_name: Default From name
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://app.emboxia.com/api/v1/lists \
-d api_token=TU_TOKEN_DE_API \
-d name=List+1 \
-d from_email=admin@abccorp.org \
-d from_name=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/listsGet information about all 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://app.emboxia.com/api/v1/lists \
-d api_token=TU_TOKEN_DE_API

GET/api/v1/lists/{uid}Get information about a specific list

Get information about a specific list

Returns

All list informations in json

Example

curl -X GET -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/lists/{uid} \
-d api_token=TU_TOKEN_DE_API

POST/api/v1/lists/{uid}/add-fieldAdd custom field to list

Add custom field to list

Parameters

$type: Choose one of these types: text, number, datetime.
$label: Field' label
$tag: The tag name may have alpha-numeric characters, as well as dashes and underscores.
$default_valueOptional: Default value of the field

Returns

Creation messages in json

Example

curl -X POST -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/lists/{uid}/add-field \
-d api_token=TU_TOKEN_DE_API \
-d type=text \
-d label=Custom \
-d tag=CUSTOM_FIELD_1 \
-d default_value=test

DELETE/api/v1/lists/{uid}Delete a list

Delete a list

Parameters

$uid: List's uid

Returns

Result messages in json

Example

curl -X DELETE -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/lists/{uid} \
-d api_token=TU_TOKEN_DE_API

CAMPAIGNS

GET/api/v1/campaignsGet information about all campaigns

Get information about all campaigns

Parameters

$per_pageOptional: Number of subscribers per page
$page: Page number

Returns

List of all user's campaigns in json

Example

curl -X GET -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/campaigns \
-d api_token=TU_TOKEN_DE_API

POST/api/v1/campaignsAdd new campaign

Add new campaign

Parameters

$list_uid: List's uid
$name: New campaign name
$subject: Email subject
$from_email: From email
$from_name: From name
$reply_to: Reply-to email
$track_openOptional: Track open (true|false)
$track_clickOptional: Track click (true|false)
$sign_dkimOptional: Sign dkim (true|false)
$skip_failed_messagesOptional: Track open (true|false)
$htmlOptional: Campaign HTML content

Returns

New campaign's information in json

Example

curl -X POST -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/campaigns \
-d api_token=TU_TOKEN_DE_API \
-d mail_list_uid={list_uid} \
-d name=MyCampaign \
-d subject=HelloWorld \
-d from_email=noreply@gmail.com \
-d from_name=NoReply \
-d reply_to=noreply@gmail.com \
-d track_open=true \
-d track_click=true \
-d sign_dkim=false \
-d skip_failed_messages=false \
-d html='<p>Hello!</p>'

GET/api/v1/campaigns/{uid}Get information about a specific campaign

Get information about a specific campaign

Returns

Campaign's information in json

Example

curl -X GET -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/campaigns/{uid} \
-d api_token=TU_TOKEN_DE_API

PATCH/api/v1/campaigns/{uid}Update campaign

Update campaign

Parameters

$list_uid: List's uid
$name: Campaign name
$subject: Email subject
$from_email: From email
$from_name: From name
$reply_to: Reply-to email
$track_openOptional: Track open (true|false)
$track_clickOptional: Track click (true|false)
$sign_dkimOptional: Sign dkim (true|false)
$skip_failed_messagesOptional: Track open (true|false)

Returns

New campaign's information in json

Example

curl -X PATCH -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/campaigns/{uid} \
-d api_token=TU_TOKEN_DE_API \
-d name=MyCampaign2 \
-d subject=HelloWorld2 \
-d sign_dkim=true

POST/api/v1/campaigns/{uid}/runRun a specific campaign

Run a specific campaign

Returns

Action messages in json

Example

curl -X POST -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/campaigns/{uid}/run \
-d api_token=TU_TOKEN_DE_API

POST/api/v1/campaigns/{uid}/pausePause a specific campaign

Pause a specific campaign

Returns

Action messages in json

Example

curl -X POST -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/campaigns/{uid}/pause \
-d api_token=TU_TOKEN_DE_API

POST/api/v1/campaigns/{uid}/resumeResume a specific campaign

Resume a specific campaign

Returns

Action messages in json

Example

curl -X POST -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/campaigns/{uid}/resume \
-d api_token=TU_TOKEN_DE_API

DELETE/api/v1/campaigns/{uid}Delete a campaign

Delete a campaign

Parameters

$uid: Campaign's uid

Returns

Result messages in json

Example

curl -X DELETE -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/campaigns/{uid} \
-d api_token=TU_TOKEN_DE_API

SUBSCRIBERS

GET/api/v1/subscribersDisplay list

Display list

Parameters

$list_uid: List's uid
$openOptional: yes - opened some campaigns
no - not opened any campaign
$clickOptional: yes - clicked some campaigns
no - not clicked any campaign
$per_pageOptional: 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://app.emboxia.com/api/v1/subscribers \
-d api_token=TU_TOKEN_DE_API \
-d list_uid={list_uid} \
-d per_page=20 \
-d page=1

POST/api/v1/subscribersCreate subscriber for a mail list

Create subscriber for a mail list

Parameters

$list_uid: List's uid
$EMAIL: Subscriber's email
$tagOptional: Subscriber's tags, seperated by a comma (,).
$statusOptional: Subscriber's status: subscribed | unsubscribed | unconfirmed
$[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://app.emboxia.com/api/v1/subscribers \
-d api_token=TU_TOKEN_DE_API \
-d list_uid={list_uid} \
-d EMAIL=test@gmail.com \
-d tag=foo,bar,tag+with+space, \
-d FIRST_NAME=Marine \
-d LAST_NAME=Joze \
-d status=subscribed

GET/api/v1/subscribers/{id}Get information about a specific subscriber

Get information about a specific subscriber

Parameters

$id: Subsciber's id or email

Returns

All subscriber information in json

Example

curl -X GET -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/subscribers/{id} \
-d api_token=TU_TOKEN_DE_API

PATCH/api/v1/subscribers/{id}Update subscriber for a mail list

Update subscriber for a mail list

Parameters

$uid: Subscriber's uid
$EMAIL: Subscriber's email
$tagOptional: Subscriber's tags, seperated by a comma (,).
$[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://app.emboxia.com/api/v1/subscribers/{id} \
-d api_token=TU_TOKEN_DE_API \
-d EMAIL=test@gmail.com \
-d tag=foo,bar,tag+with+space, \
-d FIRST_NAME=Marine \
-d LAST_NAME=Joze \
-d status=unsubscribed

POST/api/v1/subscribers/{id}/add-tagAdd tag(s) to subscriber

Add tag(s) to subscriber

Parameters

$tagOptional: Subscriber's tags, seperated by a comma (,).

Returns

Creation messages in json

Example

curl -X POST -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/subscribers/-ID-/add-tag \
-d api_token=TU_TOKEN_DE_API \
-d tag=foo,bar,tag+with+space

POST/api/v1/subscribers/{id}/remove-tagRemove tag(s) to subscriber

Remove tag(s) to subscriber

Parameters

$tagOptional: Subscriber's tags, seperated by a comma (,).

Returns

Update messages in json

Example

curl -X POST -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/subscribers/-ID-/remove-tag \
-d api_token=TU_TOKEN_DE_API \
-d tag=foo,bar,tag+with+space

GET/api/v1/subscribers/email/{email}Find subscribers with 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://app.emboxia.com/api/v1/subscribers/email/{email} \
-d api_token=TU_TOKEN_DE_API

PATCH/api/v1/lists/{list_uid}/subscribers/{id}/subscribeSubscribe a subscriber

Subscribe a subscriber

Parameters

$list_uid: List's uid
$id: Subsciber's id

Returns

Result messages in json

Example

curl -X PATCH -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/lists/{list_uid}/subscribers/{id}/subscribe \
-d api_token=TU_TOKEN_DE_API

PATCH/api/v1/lists/{list_uid}/subscribers/{id}/unsubscribeUnsubscribe a subscriber

Unsubscribe a subscriber

Parameters

$list_uid: List's uid
$id: Subsciber's id

Returns

Result messages in json

Example

curl -X PATCH -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/lists/{list_uid}/subscribers/{id}/unsubscribe \
-d api_token=TU_TOKEN_DE_API

PATCH/api/v1/lists/{list_uid}/subscribers/email/{email}/unsubscribeUnsubscribe a subscriber

Unsubscribe a subscriber

Parameters

$list_uid: List's uid
$email: Subsciber's email

Returns

Result messages in json

Example

curl -X PATCH -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/lists/{list_uid}/subscribers/email/{email}/unsubscribe \
-d api_token=TU_TOKEN_DE_API

DELETE/api/v1/subscribers/{id}Delete a subscriber

Delete a subscriber

Parameters

$list_uid: List's uid
$id: Subsciber's id

Returns

Result messages in json

Example

curl -X DELETE -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/subscribers/{id} \
-d api_token=TU_TOKEN_DE_API

Notification

POST/api/v1/notification/bounceSend a HARD bounce to the application

Send a HARD bounce to the application

Parameters

$message_id: Message's id
$description: Notification message

Returns

Action messages in json

Example

curl -X POST -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/notification/bounce \
-d api_token=TU_TOKEN_DE_API  \
-d message_id=201637442604422402.6199642caf7f3@example.com

Feedback Loop

POST/api/v1/notification/feedbackSend a bounce or abuse report to the application

Send a bounce or abuse report to the application

Parameters

$message_id: Message's id
$type: Poassible values include: spam | abuse
$description: Notification message

Returns

Action messages in json

Example

curl -X POST -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/notification/feedback \
-d api_token=TU_TOKEN_DE_API  \
-d message_id=201637442604422402.6199642caf7f3@example.com  \
-d type=abuse

FILE

POST/api/v1/file/uploadUpload file(s) to customer

Upload file(s) to customer

Parameters

$file_url: File url
$subdirectoryOptional: Custom subdirectory

Returns

Upload result message

Example

curl -X POST -H "accept:application/json" -G \
https://app.emboxia.com/api/v1/file/upload \
-d api_token=TU_TOKEN_DE_API  \
-d files='[{"url":"http://example.com/images/logo_big.svg","subdirectory":"path/to/file"},{"url":"http://example.com/images/logo_big.svg","subdirectory":"path/to/file2"}]'

These are the 29 available endpoints. To see the examples with your own token, sign in to your panel.