API Documentation
[Base-URL] (Can be found from Application Settings => API => API Base URL)
Groups Retrieve All Groups
GET [Base-URL]/groups
Parameters Type Description api_token string (required) Your API Key type_id integer (optional) Will fetch the groups of specific a type otherwise all.Available type_id: ListBroadcastSending ServersSuppression starts_from integer (optional) From where you want to fetch the records, otherwise, it will fetch the records from 1st, (Maximum records would be 500).
Create a Group
POST [Base-URL]/groups
Parameters Type Description api_token string (required) Your API Key name string (required) Group Name, whatever you need to be store. type_id integer (required) Store a group under which module.Available type_id:ListBroadcastSending ServersSuppression
Retrieve a Group
GET [Base-URL]/groups/{id}
Parameters Type Description api_token string (required) Your API Key id integer (required) Group-ID needs to be fetched
Update a Group
PATCH [Base-URL]/groups/{id}
Parameters Type Description api_token string (required) Your API Key id integer (required) Group-ID needs to be update name string (optional) New Group Name
Delete a Group
DELETE [Base-URL]/groups/{id}
Parameters Type Description api_token string (required) Your API Key id integer (required) Group-ID needs to be deleted
Lists Retrieve All Lists
GET [Base-URL]/lists
Parameters Type Description api_token string (required) Your API Key group_id integer (optional) Will fetch the lists of specific a group, otherwise all. starts_from integer (optional) From where you want to fetch the records, otherwise, it will fetch the records from 1st, (Maximum records would be 500).
Create a List
POST [Base-URL]/lists
Parameters Type Description api_token string (required) Your API Key name string (required) List Name, whatever you need to be store. group_id integer (required) Store a list under which group. sending_server_id integer (required) When a contact is added to the list, then it will be used to send an email (welcome, confirmation, unsubscribe, etc.) to that contact. custom_field_id array (optional) Custom Fields IDs want to associate with the List. double_optin string (optional) (Yes / No) If this option is set to “Yes”, then a confirmation email will be sent to that contact welcome_email string (optional) (Yes / No) If this option is set to “Yes”, then a confirmation email will be sent to that contact notification string (optional) (Enabled / Disabled) If this option is set to “Enabled”, then an email will be sent to the “Notification Email” address notification_email string (optional) Depends on “notification”, the Email address that will receive a notification when contact is added notification_criteria array (optional) Depends on “notification”, Notification emails will be receives when criteria is matched.Criteria can be:app => when contact is added via applicationapi => when contact is added via apiwebform => when contact is added via webformconfirm => when contact is confirmedunsub => when contact is unsubscribed
Retrieve a List
GET [Base-URL]/lists/{id}
Name Type Description api_token string (required) Your API Key id integer (required) List-ID, needs to be fetched
Update a List
PATCH [Base-URL]/lists/{id}
Parameters Type Description api_token string (required) Your API Key id integer (required) List-ID needs to be update name string (optional) New List Name group_id integer (required) New Group ID, will move the list to a given group. sending_server_id integer (required) New Sending Server ID, When a contact is added to the list, then it will be used to send an email (welcome, confirmation, unsubscribe, etc.) to that contact. double_optin string (optional) (Yes / No) If this option is set to “Yes”, then a confirmation email will be sent to that contact welcome_email string (optional) (Yes / No) If this option is set to “Yes”, then a confirmation email will be sent to that contact notification string (optional) (Enabled / Disabled) If this option is set to “Enabled”, then an email will be sent to the “Notification Email” address notification_email string (optional) Depends on “notification”, the Email address that will receive a notification when contact is added notification_criteria array (optional) Depends on “notification”, Notification emails will be receives when criteria are matched.Criteria can be:app => when contact is added via applicationapi => when contact is added via apiwebform => when contact is added via webformconfirm => when contact is confirmedunsub => when contact is unsubscribed
Delete a List
DELETE [Base-URL]/lists/{id}
Parameters Type Description api_token string (required) Your API Key id integer (required) List-ID needs to be deleted
Custom Fields Retrieve All Custom Fields
GET [Base-URL]/custom-fields
Parameters Type Description api_token string (required) Your API Key starts_from integer (optional) From where you want to fetch the records, otherwise, it will fetch the records from 1st, (Maximum records would be 500).
Create a Custom Field
POST [Base-URL] /custom-fields
Parameters Type Description api_token string (required) Your API Key name string (required) Custom Field Name, whatever you need to be store. type string (required) Custom Field would be as the type is defined.Type can be:textnumbertextareadateradiocheckboxdropdown value array (optional) Value array will be used if the type is radio, checkbox, or dropdown to define the values.
Retrieve a Custom Field
GET [Base-URL]/ custom-fields/{id}
Parameters Type Description api_token string (required) Your API Key id integer (required) Custom-Field-ID, needs to be fetched
Update a Custom Field
PATCH [Base-URL]/ custom-fields/{id}
Parameters Type Description api_token string (required) Your API Key id integer (required) Custom-Field-ID, needs to be update name string (optional) New Custom Field Name
Delete a Custom Field
DELETE [Base-URL]/custom-fields/{id}
Parameters Type Description api_token string (required) Your API Key id integer (required) Custom-Field-ID needs to be deleted
Recipients Retrieve All Recipients
GET [Base-URL]/ contacts
Parameters Type Description api_token string (required) Your API Key starts_from integer (optional) From where you want to fetch the records, otherwise, it will fetch the records from 1st, (Maximum records would be 500).
Create a Recipient
POST [Base-URL] /contacts
Name Parameters Description api_token string (required) Your API Key email string (required) Contact Email, whatever you need to be store. list_id integer (required) Store a contact under which list. format string (optional) HTML / Text, default would be HTML. active string (optional) Yes / No, default would be Yes. confirm string (optional) Yes / No, default would be No. unsubscribed string (optional) Yes / No, default would be No. custom_fields array (optional) An associative array, Key would the Custom-Field-ID like:custom_fields[2] => “John”
Retrieve a Recipient
GET [Base-URL]/ contacts/{id}
Parameters Type Description api_token string (required) Your API Key id integer (required) Recipient-ID, needs to be fetched
Update a Recipient
PATCH [Base-URL]/ contacts/{id}
Parameters Type Description api_token string (required) Your API Key id integer (required) Recipient-ID needs to be update email string (optional) New Email format string (optional) HTML / Text, default would be HTML. active string (optional) Yes / No, default would be Yes. confirm string (optional) Yes / No, default would be No. unsubscribed string (optional) Yes / No, default would be No. custom_fields array (optional) An associative array, Key would the Custom-Field-ID like:custom_fields[2] => “John”
Delete a Recipient
DELETE [Base-URL]/contacts/{id}
Parameters Type Description api_token string (required) Your API Key id integer (required) Recipient-ID needs to be deleted
Campaign Retrieve All Campaigns
GET [Base-URL]/ broadcasts
Name Type Description api_token string (required) Your API Key group_id integer (optional) Will fetch the broadcasts of specific a group, otherwise all. starts_from integer (optional) From where you want to fetch the records, otherwise, it will fetch the records from 1st, (Maximum records would be 500).
Create a Campaign
POST [Base-URL] /broadcasts
Parameter Type Description api_token string (required) Your API Key name string (required) Broadcast Name, whatever you need to be store. group_id integer (required) Store a broadcast under which group. email_subject string (optional) It will be displayed as an email subject. html string (optional) HTML content of the broadcast. text string (optional) Text content of the broadcast.
Retrieve a Campaign
GET [Base-URL]/ broadcasts/{id}
Parameters Type Description api_token string (required) Your API Key id integer (required) Campaign-ID, needs to be fetched
Update a Campaign
PATCH [Base-URL]/ broadcasts/{id}
Parameter Type Description api_token string (required) Your API Key id integer (required) Recipient-ID needs to be update name string (optional) New Broadcast Name group_id integer (required) New Group-ID, will move the broadcast to a given group. email_subject string (optional) It will be displayed as an email subject. html string (optional) HTML content of the broadcast. text string (optional) Text content of the broadcast.
Delete a Campaign
DELETE [Base-URL]/broadcasts/{id}
Parameters Type Description api_token string (required) Your API Key id integer (required) Campaign-ID needs to be deleted
