API Documentation

You need to add parameter api_token=YOUR_API_TOKEN to each request to the API system
Example: https://app.emailino.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 $append_contact_footer Append contact' information to footer Returns Creation messages in json	Example: curl -X POST -H "accept:application/json" -G \ https://api.emailino.com/api/v1/lists? \ -d api_token={YOUR_API_TOKEN} \ -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 \ -d append_contact_footer=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://api.emailino.com/api/v1/lists? \ -d api_token={YOUR_API_TOKEN}
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://api.emailino.com/api/v1/lists/{uid}? \ -d api_token={YOUR_API_TOKEN}

---

CAMPAIGNS

HTTP method	Endpoint	Function
POST	/api/v1/campaigns	Create new campaign
	Parameters $name Campaign's name $from_email Default From email address $from_name Default From name $cc[]   optional Cc recipient email address. Type = array | Max = 10 $bcc[]   optional Bcc recipient email address. Type = array | Max = 10 $subject Default email subject $mail_list_uid List ID $type   optional Campaign type default "regular" $reply_to Default Replay to email address $html content html campaign $plain   optional Plan text campaign $delivery_date_time   optional Schedule run_at default current dateTime $use_default_sending_server_from_email   optional Use sending server's default value default false $track_open Discover who opens your campaigns default true $track_click Discover which campaign links were clicked $pool_name   optional Name of your custom IP Pool to be used in the sending process. $attachments[]   optional Attachment Files. Type = array | Max = 10 Returns Creation messages in json	Example: curl -X POST -H "accept:application/json" -G \ https://api.emailino.com/api/v1/campaigns? \ -d api_token={YOUR_API_TOKEN} \ -d name=Campaign+1 \ -d from_email=admin@abccorp.org \ -d from_name=ABC+Corp. \ -d cc=["admin@abccorp.org","webmaster@abccorp.org"] \ -d bcc=["bcc@abccorp.org"] \ -d subject=Welcome+to+ABC+Corp. \ -d mail_list_uid=5cdd2a8a3c6e2. \ -d type=regular \ -d reply_to=admin2@abccorp.org \ -d delivery_date_time=2019-05-16 09:25 \ -d template_source=builder \ -d use_default_sending_server_from_email=true \ -d track_open=true \ -d track_click=true \ -d sign_dkim=true \ -d attachments=[-FILE-]
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://api.emailino.com/api/v1/campaigns? \ -d api_token={YOUR_API_TOKEN}
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://api.emailino.com/api/v1/campaigns/{uid}? \ -d api_token={YOUR_API_TOKEN}
GET	/api/v1/campaigns/name/{name}	Get information about a specific campaign by name
	Returns Campaign's information in json	Example: curl -X GET -H "accept:application/json" -G \ https://api.emailino.com/api/v1/campaigns/name/{name}? \ -d api_token={YOUR_API_TOKEN}

---

transactional

HTTP method	Endpoint	Function
POST	/api/v1/transactional/send/	Send Transactional email
	Parameters $name   optional - default: Untitled Name of transactional email $to Recipient email $cc[]   optional Cc recipient email address. Type = array | Max = 10 $bcc[]   optional Bcc recipient email address. Type = array | Max = 10 $from_name Sender name $from_email Sender email $reply_to   optional - default: $from_email Reply to address subject Email subject $plain   optional Text content $html   optional HTML content $track_open true - enable open tracking false - disable open tracking $track_click true - enable click tracking false - disable click tracking $pool_name   optional Name of your custom IP Pool to be used in the sending process. $attachments[]   optional Attachment Files. Type = array | Max = 10 Returns Transactional email information in json	Example: curl -X POST -H "accept:application/json" -G \ https://api.emailino.com/api/v1/transactional/send? \ -d api_token={YOUR_API_TOKEN} \ -d name=Transactional email N1 \ -d to=recepient@domaine.com \ -d cc=["admin@abccorp.org","webmaster@abccorp.org"] \ -d bcc=["bcc@abccorp.org"] \ -d from_name=Jean. \ -d from_email=user@exemple.com \ -d reply_to=service@exemple.com \ -d subject=Hello world \ -d plain=Welcome \ -d html=<html><head><\head><body><p>Hello<\p><\body><\html> \ -d track_open=true \ -d track_click=true \ -d attachments=[-FILE-]
GET	/api/v1/transactional/status	Get information about a transactional email
	Parameters $transactional_id transactional email id $details   optional - default: false show more details about transactional email Returns transactional informations in json	Example: curl -X GET -H "accept:application/json" -G \ https://api.emailino.com /api/v1/transactional/status? \ -d api_token={YOUR_API_TOKEN}\ -d transactional_id=5ec2be6a51 \ -d details=true

---

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://api.emailino.com/api/v1/lists/{list_uid}/subscribers? \ -d api_token={YOUR_API_TOKEN} \ -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://api.emailino.com/api/v1/lists/{list_uid}/subscribers/{uid}? \ -d api_token={YOUR_API_TOKEN}
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://api.emailino.com/api/v1/subscribers/email/{email}? \ -d api_token={YOUR_API_TOKEN}
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://api.emailino.com/api/v1/lists/{list_uid}/subscribers/store? \ -d api_token={YOUR_API_TOKEN} \ -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://api.emailino.com/api/v1/lists/{list_uid}/subscribers/{uid}/update? \ -d api_token={YOUR_API_TOKEN} \ -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://api.emailino.com/api/v1/lists/{list_uid}/subscribers/{uid}/subscribe? \ -d api_token={YOUR_API_TOKEN}
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://api.emailino.com/api/v1/lists/{list_uid}/subscribers/{uid}/unsubscribe? \ -d api_token={YOUR_API_TOKEN}
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://api.emailino.com/api/v1/lists/{list_uid}/subscribers/{uid}/delete? \ -d api_token={YOUR_API_TOKEN}
POST	/api/v1/lists/{list_uid}/subscribers/import	Import file to list
	Parameters $list_uid List's uid $file File format csv Returns Result messages in json	Example: curl -X POST -H "accept:application/json" -G \ https://api.emailino.com/api/v1/lists/{list_uid}/subscribers/import?file=-FILE-? \ -d api_token={YOUR_API_TOKEN}
POST	/api/v1/lists/{list_uid}/subscribers/add-tag	Add tag to subscriber
	Parameters $list_uid List's uid Returns Result messages in json	Example: curl -X POST -H "accept:application/json" -G \ https://api.emailino.com/api/v1/lists/{list_uid}/subscribers/add-tag? \ -d api_token={YOUR_API_TOKEN} \ -d email=example@domaine.com -d tag=example

---

Plan

HTTP method	Endpoint	Function
GET	/api/v1/plans	Get information about all plans
	Returns List of all plans in json	Example: curl -X GET -H "accept:application/json" -G \ https://api.emailino.com/api/v1/plans? \ -d api_token={YOUR_API_TOKEN}
POST	/api/v1/plans	Add new plan
	Parameters $name Plan's name $currency_id Currency's id $frequency_amount Billing recurs every this amount of time $frequency_unit Time unit for billing recurs (day, week, month, year, unlimited) $price Plan's price $color Plan's color (red, blue, #008c6e, #917319,...) $options[...]   optional Plan's options... email_max: Email sending credits (number, -1 for unlimited) list_max: Max lists (number, -1 for unlimited) subscriber_max: Max subscribers (number, -1 for unlimited) subscriber_per_list_max: Max subscribers per list (number, -1 for unlimited) segment_per_list_max: Max segments per list (number, -1 for unlimited) campaign_max: Max campaigns (number, -1 for unlimited) automation_max: Max automations (number, -1 for unlimited) sending_quota: Sending credits (number, -1 for unlimited) sending_quota_time: Time value (number, -1 for unlimited) sending_quota_time_unit: Time unit (day|hour|minute) max_process: Max number of processes (number) all_sending_servers: Use all sending servers (yes|no) max_size_upload_total: Maximum size of all files (MB) (number) max_file_size_upload: Maximum upload size per file (MB) (number) unsubscribe_url_required: {UNSUBSCRIBE_URL} tag is required (yes|no) access_when_offline: Access when site is offline (yes|no) create_sending_domains: Allows customer to add sending domains (yes|no) sending_servers_max: Max sending servers per customer (number, -1 for unlimited) sending_domains_max: Max sending domains per customer (number, -1 for unlimited) all_email_verification_servers: Use all email verification servers (yes|no) create_email_verification_servers: Allows customer to add email verification servers (yes|no) email_verification_servers_max: Max email verification servers per customer (number, -1 for unlimited) list_import: Customer can import list (yes|no) list_export: Customer can export list (yes|no) all_sending_server_types: Allow customer to add any sending server type (yes|no) sending_server_types: (array) sending_server_option: (system|own|subaccount) sending_server_subaccount_uid Returns Creation messages in json	Example: curl -X POST -H "accept:application/json" -G \ https://api.emailino.com/api/v1/plans? \ -d api_token={YOUR_API_TOKEN} \ -d name=Advanced \ -d currency_id=1 \ -d frequency_amount=1 \ -d frequency_unit=month \ -d price=20 \ -d color=red \ -d options[sending_server_option]=own \ -d options[email_max]=10000

---

SENDING SERVER

HTTP method	Endpoint	Function
GET	/api/v1/sending_servers	Get information about all sending servers
	Returns List of all sending servers in json	Example: curl -X GET -H "accept:application/json" -G \ https://api.emailino.com/api/v1/sending_servers? \ -d api_token={YOUR_API_TOKEN}

---

Customer

HTTP method	Endpoint	Function
POST	/api/v1/customers	Add new customer
	Returns Creation messages in json	Example: curl -X POST -H "accept:application/json" -G \ https://api.emailino.com/api/v1/customers? \ -d api_token={YOUR_API_TOKEN} \ -d email=user_name@gmail.com \ -d first_name=Luan \ -d last_name=Pham \ -d timezone=America/Godthab \ -d language_id=1 \ -d password=123456
GET	/api/v1/customers/{uid}	Get information about a specific customer
	Parameters $uid Customer's uid Returns Customer information in json (profile, contact, sunscriptions,... )	Example: curl -X GET -H "accept:application/json" -G \ https://api.emailino.com/api/v1/customers/{uid}? \ -d api_token={YOUR_API_TOKEN}
PATCH	/api/v1/customers	Update customer
	Parameters $uid Customer's uid Returns Creation messages in json	Example: curl -X PATCH -H "accept:application/json" -G \ https://api.emailino.com/api/v1/customers/{uid}? \ -d api_token={YOUR_API_TOKEN} \ -d email=user_name@gmail.com \ -d first_name=Luan \ -d last_name=Pham \ -d timezone=America/Godthab \ -d language_id=1 \ -d password=123456
PATCH	/api/v1/customers/{uid}/enable	Enable customer
	Parameters $uid Customer's uid Returns Action messages in json	Example: curl -X PATCH -H "accept:application/json" -G \ https://api.emailino.com/api/v1/customers/{uid}/enable? \ -d api_token={YOUR_API_TOKEN}
PATCH	/api/v1/customers/{uid}/disable	Disable customer
	Parameters $uid Customer's uid Returns Action messages in json	Example: curl -X PATCH -H "accept:application/json" -G \ https://api.emailino.com/api/v1/customers/{uid}/disable? \ -d api_token={YOUR_API_TOKEN}
POST	/api/v1/customers/{uid}/assign-plan/{plan_uid}	Assign Plan to Customer
	Parameters $uid Customer's uid $plan_uid Plan's uid Returns Action messages in json	Example: curl -X POST -H "accept:application/json" -G \ https://api.emailino.com/api/v1/customers/{uid}/assign-plan/{plan_uid}? \ -d api_token={YOUR_API_TOKEN}

---

Subscription

HTTP method	Endpoint	Function
POST	/api/v1/subscriptions	Subscribe customer to a plan
	Parameters $customer_uid Customer's uid $plan_uid Plan's uid $start_at   optional - default: Next customer's subscription start date Subscription's start date $end_at   optional - default: End date of the plan from start_at date Subscription's end date Returns Action messages in json	Example: curl -X POST -H "accept:application/json" -G \ https://api.emailino.com/api/v1/subscriptions? \ -d api_token={YOUR_API_TOKEN} \ -d customer_uid={customer_uid} \ -d plan_uid={plan_uid}

---

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://api.emailino.com/api/v1/file/upload? \ -d api_token={YOUR_API_TOKEN} \ -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"}]'

---

Fields

HTTP method	Endpoint	Function
POST	/api/v1/lists/{list_uid}/fields/store	Manage list fields
	Parameters $fields Array of fields Returns Creation messages in json	Example: curl -X POST -H "accept:application/json" -G \ https://api.emailino.com/api/v1/lists/{list_uid}/fields/store? \ -d api_token={YOUR_API_TOKEN} \ -d fields=[{"uid": "","label": "Email","type": "text","tag": "EMAIL","default_value": "","visible": "1","required": "1","custom_order": "0"}, {"uid": "","label": "First name","type": "text","tag": "FIRST_NAME","default_value": "","visible": "1","required": "0","custom_order": "0"}, {"uid": "","label": "Last name","type": "text","tag": "LAST_NAME","default_value": "","visible": "1","required": "0","custom_order": "0"}, {"uid": "","label": "mail_crypt","type": "text","tag": "MAIL_CRYPT","default_value": "","visible": "1","required": "0","custom_order": "0"}]
GET	/api/v1/lists/{list_uid}/fields	Get fields information about a specific list
	Parameters $list_uid List uid Returns All fields information in json	Example: curl -X GET -H "accept:application/json" -G \ https://api.emailino.com/api/v1/lists/{list_uid}/fields? \ -d api_token={YOUR_API_TOKEN}

---

Statistics

HTTP method	Endpoint	Function
GET	/api/v1/campaigns/{uid}/status	Get campaign status
	Parameters $showDelivered   optional Type=boolean | Default value=false $showFailed   optional Type=boolean | Default value=false $showOpened   optional Type=boolean | Default value=false $showClicked   optional Type=boolean | Default value=false $showAbuse   optional Type=boolean | Default value=false $showBounced   optional Type=boolean | Default value=false $showUnsubscribed   optional Type=boolean | Default value=false Returns Statistics messages in json	Example: curl -X GET -H "accept:application/json" -G \ https://api.emailino.com/api/v1/campaigns/{list_uid}/status? \ -d api_token={YOUR_API_TOKEN} \ -d showDelivered=true \ -d showFailed=true \ -d showOpened=true \ -d showClicked=true \ -d showAbuse=true \ -d showBounced=true \ -d showUnsubscribed=true

---