Version: V1
[Base-URL] (You can locate it under Application Settings → API → Base URL)
Groups
Get all of the group types
| Parameters | Type | Description |
|---|---|---|
| api_token | string (required) | Your API Key |
Get all of the groups
| Parameters | Type | Description |
|---|---|---|
| api_token | string (required) | Your API Key |
| type_id | integer (optional) | Retrieves groups of a specific type if a type_id is provided; otherwise, it fetches all groups. Available type_id values: |
| starts_from | integer (optional) | Specifies the starting point for fetching records. If not provided, records will be retrieved starting from the first. |
| limit | integer (optional) | Fetches the specified number of records if a limit is provided; otherwise, the default is 100 records. |
Get a single group detail
| Parameters | Type | Description |
|---|---|---|
| api_token | string (required) | Your API Key |
Add a group
| Parameters | Type | Description |
|---|---|---|
| api_token | string (required) | Your API Key |
| name | string (required) | The group name to be stored as required. |
| type_id | integer (required) | Specifies the module under which the group will be stored. Available type_id values:1: Lists 2: Campaigns 3: Delivery Servers 4: Sending Domains 5: Suppressions |
Update a group
| Parameters | Type | Description |
|---|---|---|
| api_token | string (required) | Your API Key |
| name | string (required) | The group name to be stored as required. |
Delete a group
| Parameters | Type | Description |
|---|---|---|
| api_token | string (required) | Your API Key |
Lists
Get all of the lists
| Parameters | Type | Description |
|---|---|---|
| api_token | string (required) | Your API Key |
| group_id | integer (optional) | Retrieves lists for a specific group if specified; otherwise, fetches all lists. |
| starts_from | integer (optional) | Specifies the starting point for fetching records. If not provided, records will be retrieved starting from the first. |
| limit | integer (optional) | Fetches the specified number of records if a limit is provided; otherwise, the default is 100 records. |
Get a list
| Parameters | Type | Description |
|---|---|---|
| api_token | string (required) | Your API Key |
Add a list
| Parameters | Type | Description |
|---|---|---|
| api_token | string (required) | Your API Key |
| name | string (required) | The name of the list to be stored as desired. |
| group_id | integer (required) | Specifies the group under which the list will be stored. |
| from_subject | string (required) | This can be utilized in the campaign to set the subject line of the email being sent. |
| from_name | string (required) | This can be used in the campaign to identify or reference the source of the contact information. |
| from_email | string (required) | This can be used in the campaign to specify the sender’s email address for the outgoing emails. |
| reply_email | string (required) | This can be used in the campaign to specify the email address where replies to the campaign emails should be sent. |
| description | string (optional) | A brief description of the list. |
| double_optin | string (optional) | (Yes / No) If set to “Yes,” a confirmation email will be sent to the contact to verify their subscription. |
| welcome_email | string (optional) | (Yes / No) If set to “Yes,” a welcome email will be sent to the contact. |
| notify_email | string (optional) | The admin will receive notifications at this email address regarding contact additions, unsubscribes, and double opt-ins. |
| custom_field_ids | array (optional) | Custom Field IDs that need to be associated with the List. |
Update a list
| Parameters | Type | Description |
|---|---|---|
| api_token | string (required) | Your API Key |
| name | string (optional) | The name of the list to be stored as desired. |
| group_id | integer (optional) | Specifies the group under which the list will be stored. |
| from_subject | string (optional) | This can be utilized in the campaign to set the subject line of the email being sent. |
| from_name | string (optional) | This can be used in the campaign to identify or reference the source of the contact information. |
| from_email | string (optional) | This can be used in the campaign to specify the sender’s email address for the outgoing emails. |
| reply_email | string (optional) | This can be used in the campaign to specify the email address where replies to the campaign emails should be sent. |
| description | string (optional) | A brief description of the list. |
| double_optin | string (optional) | (Yes / No) If set to “Yes,” a confirmation email will be sent to the contact to verify their subscription. |
| welcome_email | string (optional) | (Yes / No) If set to “Yes,” a welcome email will be sent to the contact. |
| notify_email | string (optional) | The admin will receive notifications at this email address regarding contact additions, unsubscribes, and double opt-ins. |
| custom_field_ids | array (optional) | Custom Field IDs that need to be associated with the List. |
Delete a list
| Parameters | Type | Description |
|---|---|---|
| api_token | string (required) | Your API Key |
Custom Fields
Get all of the custom fields
| Parameters | Type | Description |
|---|---|---|
| api_token | string (required) | Your API Key |
| starts_from | integer (optional) | Specifies the starting point for fetching records. If not provided, records will be retrieved starting from the first. |
| limit | integer (optional) | Fetches the specified number of records if a limit is provided; otherwise, the default is 100 records. |
Get a custom field
GET
[Base-URL]/custom_fields/[id]
| Parameters | Type | Description |
|---|---|---|
| api_token | string (required) | Your API Key |
Add a custom field
| Parameters | Type | Description |
|---|---|---|
| api_token | string (required) | Your API Key |
| name | string (required) | The name of the custom field to be stored as desired. |
| type | string (required) | The custom field will be defined based on its type. Type can be: – text – number – textarea – date – radio – checkbox – dropdown |
| values | array (optional) | The value array will be used to define the options when the type is radio, checkbox, or dropdown. |
Update a custom field
PATCH
[Base-URL]/custom_fields/[id]
| Parameters | Type | Description |
|---|---|---|
| api_token | string (required) | Your API Key |
| name | string (optional) | The name of the custom field to be stored as desired. |
| type | string (optional) | The custom field will be defined based on its type. Type can be: – text – number – textarea – date – radio – checkbox – dropdown |
| values | array (optional) | The value array will be used to define the options when the type is radio, checkbox, or dropdown. |
Delete a custom field
DELETE
[Base-URL]/custom_fields/[id]
| Parameters | Type | Description |
|---|---|---|
| api_token | string (required) | Your API Key |
Contacts
Get all of the contacts
| Parameters | Type | Description |
|---|---|---|
| api_token | string (required) | Your API Key |
| starts_from | integer (optional) | Specifies the starting point for fetching records. If not provided, records will be retrieved starting from the first. |
| limit | integer (optional) | Fetches the specified number of records if a limit is provided; otherwise, the default is 100 records. |
Get a contact
| Parameters | Type | Description |
|---|---|---|
| api_token | string (required) | Your API Key |
Add a contact
| Parameters | Type | Description |
|---|---|---|
| api_token | string (required) | Your API Key |
| string (required) | Contact email to be stored as required. | |
| list_id | integer (required) | Assign the contact to a specific list. |
| is_active | bool (optional) | 0 or 1, with 1 being the default. |
| is_confirmed | bool (optional) | 0 or 1, with 0 being the default. |
| is_verified | bool (optional) | 0 or 1, with 0 being the default. |
| is_unsubscribed | bool (optional) | 0 or 1, with 0 being the default. |
| custom_fields | array (optional) | An associative array where the key represents the Custom Field ID, for example:custom_fields[1] => "Alex" |
| allow_duplicate | bool (optional) | If you wish to overwrite the contact, the default value will be 0. |
Update a contact
| Parameters | Type | Description |
|---|---|---|
| api_token | string (required) | Your API Key |
| string (optional) | Valid contact email | |
| list_id | integer (optional) | Assign the contact to a specific list. |
| is_active | bool (optional) | 0 or 1, with 1 being the default. |
| is_confirmed | bool (optional) | 0 or 1, with 0 being the default. |
| is_verified | bool (optional) | 0 or 1, with 0 being the default. |
| is_unsubscribed | bool (optional) | 0 or 1, with 0 being the default. |
| custom_fields | array (optional) | An associative array where the key represents the Custom Field ID, for example:custom_fields[1] => "Alex" |
Delete a contact
DELETE
[Base-URL]/contacts/[id]
| Parameters | Type | Description |
|---|---|---|
| api_token | string (required) | Your API Key |
Clients
Get all of the clients
| Parameters | Type | Description |
|---|---|---|
| api_token | string (required) | Your API Key |
| starts_from | integer (optional) | Specifies the starting point for fetching records. If not provided, records will be retrieved starting from the first. |
| limit | integer (optional) | Fetches the specified number of records if a limit is provided; otherwise, the default is 100 records. |
Get a client
| Parameters | Type | Description |
|---|---|---|
| api_token | string (required) | Your API Key |
Add a client
| Parameters | Type | Description |
|---|---|---|
| api_token | string (required) | Your API Key |
| string (required) | Valid client email. | |
| role_id | integer (required) | Assign the client to a specific role. |
| package_id | integer (required) | Assign the client to a specific package. |
| password | string (optional) | password for the client |
| is_active | bool (optional) | 0 or 1, with 1 being the default. |
| address | string (optional) | Client address |
| phone | string (optional) | Client phone number |
Update a client
| Parameters | Type | Description |
|---|---|---|
| api_token | string (required) | Your API Key |
| string (optional) | Contact email to be stored as required. | |
| role_id | integer (optional) | Assign the client to a specific role. |
| package_id | integer (optional) | Assign the client to a specific package. |
| password | string (optional) | password for the client |
| is_active | bool (optional) | 0 or 1, with 1 being the default. |
| address | string (optional) | Client address |
| phone | string (optional) | Client phone number |
Delete a client
| Parameters | Type | Description |
|---|---|---|
| api_token | string (required) | Your API Key |