Name | Example Value | Default Value | Description | Type | Data Type | Required | |
---|---|---|---|---|---|---|---|
count | 100 | 100 | Record Limit | query | integer | ||
offset | 0 | 0 | Record Offset | query | integer | ||
status | 1 | all | Campaign Status | query | reference: (campaign_status) |
Name | Data Type | Reference | Description | |
---|---|---|---|---|
campaign_id | string(38) | Campaign ID | ||
html_content | boolean | html_content | ||
status | integer(3) | campaign_status | Campaign Status | |
create_time | ISO8601 | Time of creation | ||
source | integer(3) | campaign_source | Source | |
title | string(100) | Campaign Title | ||
send_from | ISO8601 | Send From | ||
send_to | ISO8601 | Send To | ||
statistics | array | Statistics | ||
statistics: | subscribers | integer | Subscribers Count | |
statistics: | sent | integer | Count of Sent Emails | |
statistics: | opens | integer | Count of Opens | |
statistics: | opens_unique | integer | Count Opens Unique | |
statistics: | clicks | integer | Count of Clicks | |
statistics: | clicks_unique | integer | Count of Clicks Unique | |
statistics: | undelivered | integer | Count of Undelivered | |
statistics: | unsubscribed | integer | Count of Unsubscribed | |
statistics: | spam | integer | Count of Spam | |
statistics: | domain | integer | Count of Domains | |
statistics: | external_url | string | External Link | |
statistics: | external_date | ISO8601 | Date of External Validity | |
statistics: | click_rate | float | Click-through Rate (%) | |
statistics: | open_rate | float | Open Rate (%) | |
settings | array | Settings | ||
settings: | subject | string(100) | Subject | |
settings: | sender_email | string(100) | Sender Email | |
settings: | sender_name | string(100) | Sender Name | |
settings: | folder_id | integer | Folder ID | |
settings: | plan_time | ISO8601 | Scheduled Time | |
lists | array | Distribution Lists | ||
lists: | list_id | string(38) | List ID | |
lists: | name | string(100) | Name | |
lists: | subscribers | integer | Subscribers Count |
Code | Status | Example Body |
---|---|---|
200 | OK |
|
Name | Example Value | Default Value | Description | Type | Data Type | Required | |
---|---|---|---|---|---|---|---|
id | e77ced3a-89f2-2cf4-bf1f-42c5d49ed777 | null | Campaign ID | path | string(38) |
Name | Data Type | Reference | Description | |
---|---|---|---|---|
campaign_id | string(38) | Campaign ID | ||
html_content | boolean | HTML Content | ||
status | integer(3) | campaign_status | Campaign Status | |
create_time | ISO8601 | Create Time | ||
source | integer(3) | campaign_source | Source | |
title | string(100) | Campaign Title | ||
send_from | ISO8601 | Send From | ||
send_to | ISO8601 | Send To | ||
statistics | array | Statistics | ||
statistics: | subscribers | integer | Count of Subscribers | |
statistics: | sent | integer | Count of Sent Emails | |
statistics: | opens | integer | Count of Opens | |
statistics: | opens_unique | integer | Count Opens Unique | |
statistics: | clicks | integer | Count of Clicks | |
statistics: | clicks_unique | integer | Count of Clicks Unique | |
statistics: | undelivered | integer | Count of Undelivered | |
statistics: | unsubscribed | integer | Count of Unsubscribed | |
statistics: | spam | integer | Count of Spam | |
statistics: | domain | integer | Count of Domains | |
statistics: | external_url | string | External Link | |
statistics: | external_date | ISO8601 | Date of External Validity | |
statistics: | click_rate | float | Click-through Rate (%) | |
statistics: | open_rate | float | Open Rate (%) | |
settings | array | Settings | ||
settings: | subject | string(100) | Subject | |
settings: | sender_email | string(100) | Sender Email | |
settings: | sender_name | string(100) | Sender Name | |
settings: | folder_id | integer | Folder ID | |
settings: | plan_time | ISO8601 | Scheduled Time | |
lists | array | Distribution Lists | ||
lists: | list_id | string(38) | List ID | |
lists: | name | string(100) | Name | |
lists: | subscribers | integer | Count of Subscribers | |
content | string | Content Body |
Code | Status | Example Body |
---|---|---|
200 | OK |
|
Overview of list of subscribers in a standard campaign.
Name | Example Value | Default Value | Description | Type | Data Type | Required | |
---|---|---|---|---|---|---|---|
id | e77ced3a-89f2-2cf4-bf1f-42c5d49ed777 | null | Campaign ID | path | string(38) | ||
count | 100 | 100 | Record Limit | query | integer | ||
offset | 0 | 0 | Record Offset | query | integer |
Name | Data Type | Reference | Description | |
---|---|---|---|---|
email_id | string(38) | Email ID | ||
string(100) | Email address | |||
first_name | string(100) | First Name | ||
last_name | string(100) | Last Name |
Code | Status | Example Body |
---|---|---|
200 | OK |
|
Name | Data Type | Reference | Description | |
---|---|---|---|---|
campaign_id | string(38) | Campaign ID | ||
subscribers | integer | Count of Subscribers | ||
sent | integer | Count of Sent Emails | ||
opens | integer | Count of Opens | ||
opens_unique | integer | Count of Opens Unique | ||
clicks | integer | Count of Clicks | ||
clicks_unique | integer | Count of Clicks Unique | ||
undelivered | integer | Count of Undelivered | ||
unsubscribed | integer | Count of Unsubscribed | ||
spam | integer | Count of Spam | ||
domain | integer | Count of Domains | ||
external_url | string | External Link | ||
external_date | ISO8601 | External Validity Date | ||
click_rate | float | Click-through Rate (%) | ||
open_rate | float | Open Rate (%) |
Code | Status | Example Body |
---|---|---|
200 | OK |
|
Create third-party access to the statistics of a standard campaign
Name | Example Value | Default Value | Description | Type | Data Type | Required | |
---|---|---|---|---|---|---|---|
id | e77ced3a-89f2-2cf4-bf1f-42c5d49ed777 | null | Campaign ID | path | string(38) | ||
external_date | 2016-05-18T12:50:57+02:00 | NOW + 1 month | Validity Date | body | ISO8601 |
Name | Data Type | Reference | Description | |
---|---|---|---|---|
campaign_id | string(38) | Campaign ID | ||
external_url | string | External URL | ||
external_date | ISO8601 | External Date |
Code | Status | Example Body |
---|---|---|
200 | OK |
|
Get a content of a standard campaign
Name | Example Value | Default Value | Description | Type | Data Type | Required | |
---|---|---|---|---|---|---|---|
id | e77ced3a-89f2-2cf4-bf1f-42c5d49ed777 | null | Campaign ID | path | string(38) |
Name | Data Type | Reference | Description | |
---|---|---|---|---|
body | string | Campaign Body |
Code | Status | Example Body |
---|---|---|
200 | OK |
|
Name | Example Value | Default Value | Description | Type | Data Type | Required | |
---|---|---|---|---|---|---|---|
id | e77ced3a-89f2-2cf4-bf1f-42c5d49ed777 | null | Campaign ID | path | string(38) |
Name | Data Type | Reference | Description | |
---|---|---|---|---|
campaign_id | string(38) | Campaign ID | ||
message | string | Message |
Code | Status | Example Body |
---|---|---|
200 | OK |
|
Name | Example Value | Default Value | Description | Type | Data Type | Required | |
---|---|---|---|---|---|---|---|
id | e77ced3a-89f2-2cf4-bf1f-42c5d49ed777 | null | Campaign ID | path | string(38) | ||
plan_time | 2016-05-18T12:50:57+02:00 | NOW | Scheduled Time | body | ISO8601 |
Name | Data Type | Reference | Description | |
---|---|---|---|---|
campaign_id | string(38) | Campaign ID | ||
plan_time | ISO8601 | Scheduled Time | ||
message | string | Message |
Code | Status | Example Body |
---|---|---|
200 | OK |
|
Name | Example Value | Default Value | Description | Type | Data Type | Required | |
---|---|---|---|---|---|---|---|
id | e77ced3a-89f2-2cf4-bf1f-42c5d49ed777 | null | Campaign ID | path | string(38) | ||
john.doe@example.com | null | Email address | body | string |
Name | Data Type | Reference | Description | |
---|---|---|---|---|
campaign_id | string(38) | Campaign ID | ||
string | ||||
message | string | Message |
Code | Status | Example Body |
---|---|---|
200 | OK |
|
Cancellation of a selected campaign in a progress of sending
Name | Example Value | Default Value | Description | Type | Data Type | Required | |
---|---|---|---|---|---|---|---|
id | e77ced3a-89f2-2cf4-bf1f-42c5d49ed777 | null | Campaign ID | path | string(38) |
Name | Data Type | Reference | Description | |
---|---|---|---|---|
campaign_id | string(38) | Campaign ID | ||
message | string | Message |
Code | Status | Example Body |
---|---|---|
200 | OK |
|
Name | Example Value | Default Value | Description | Type | Data Type | Required | |
---|---|---|---|---|---|---|---|
title | My Campaign | null | Tite | body | string(100) | ||
html_content | true | true | HTML Content | body | boolean | ||
settings | empty | Settings | body | array | |||
settings: | subject | My Campaign | null | Subject | body | string(200) | |
settings: | sender_mail | john.doe@example.com | null | Sender Email | body | string(100) | |
settings: | sender_name | John Doe | null | Sender Name | body | string(100) | |
settings: | folder_id | e77ced3a-89f2-2cf4-bf1f-42c5d49ed777 | null | Folder ID | body | string(38) | |
lists | empty | Lists | body | array | |||
lists: | list_id | e77ced3a-89f2-2cf4-bf1f-42c5d49ed777 | null | Sender Name | body | string(38) | |
subscribers | empty | Subscribers | body | array | |||
subscribers: | email_id / email | e77ced3a-89f2-2cf4-bf1f-42c5d49ed777 | null | Email or Email ID | body | string(100) | |
content | <html></html> | null | Content Body | body | string |
{
"title": "My Campaign",
"html_content": true,
"settings": {
"subject": "My Campaign",
"sender_email": "john.doe@example.com",
"sender_name": "John Doe",
"folder_id": "root"
},
"content": "<html><\/html>",
"lists": [
"cec10bc4-6ddb-11e5-b85d-08002789d050"
],
"subscribers": [
"b64752a6-1a34-6548-0db7-3f3faf34916b",
"mike.johnson@example.com"
]
}
Name | Data Type | Reference | Description | |
---|---|---|---|---|
campaign_id | string(38) | Campaign ID | ||
html_content | boolean | HTML Content | ||
status | integer(3) | campaign_status | Campaign Status | |
create_time | ISO8601 | Time of Creation | ||
source | integer(3) | campaign_source | Source | |
title | string(100) | Campaign Title | ||
send_from | ISO8601 | Send From | ||
send_to | ISO8601 | Send To | ||
settings | array | Settings | ||
settings: | subject | array | Subject | |
settings: | subject: subject | string(100) | Subject | |
settings: | subject: record_status | integer | record_status | Record_status |
settings: | sender | array | Sender | |
settings: | sender: email | string(100) | Sender Email | |
settings: | sender: name | string(100) | Sender Name | |
settings: | sender: record_status | integer | record_status | Record_status |
settings: | folder | array | Folder | |
settings: | folder: folder_id | integer | Folder ID | |
settings: | folder: record_status | integer | record_status | Record_status |
settings: | plan_time | ISO8601 | Scheduled Time | |
lists | array | Distribution Lists | ||
lists: | list_id | string(38) | List ID | |
lists: | record_status | integer(3) | record_status | Body |
subscribers | array | Subscribers | ||
subscribers: | email_id | string(38) | Email ID | |
subscribers: | string(100) | Email address | ||
subscribers: | record_status | integer(3) | record_status | Body |
content | array | Content | ||
content: | body | string | Body | |
content: | record_status | integer(3) | record_status | Record Status |
Code | Status | Example Body |
---|---|---|
201 | OK |
|
Name | Example Value | Default Value | Description | Type | Data Type | Required | |
---|---|---|---|---|---|---|---|
id | e77ced3a-89f2-2cf4-bf1f-42c5d49ed777 | null | Campaign ID | path | string(38) | ||
title | My Campaign | Tite | body | string(100) NOT NULL | |||
html_content | true | true | HTML Content? | body | boolean | ||
settings | empty | Settings | body | array | |||
settings: | subject | My Campaign | null | Subject | body | string(200) | |
settings: | sender_mail | john.doe@example.com | null | Sender Email | body | string(100) | |
settings: | sender_name | John Doe | null | Sender Name | body | string(100) | |
settings: | folder_id | e77ced3a-89f2-2cf4-bf1f-42c5d49ed777 | null | Folder ID | body | string(38) | |
lists | empty | Lists | body | array | |||
lists: | list_id | e77ced3a-89f2-2cf4-bf1f-42c5d49ed777 | null | Sender Name | body | string(38) | |
subscribers | empty | Subscribers | body | array | |||
subscribers: | email_id / email | e77ced3a-89f2-2cf4-bf1f-42c5d49ed777 | null | Email or Email ID | body | string(100) | |
content | <html></html> | null | Content Body | body | string |
{
"title": "My Campaign",
"html_content": true,
"settings": {
"subject": "My Campaign",
"sender_email": "john.doe@example.com",
"sender_name": "John Doe",
"folder_id": "root"
},
"content": "<html><\/html>",
"lists": [
"cec10bc4-6ddb-11e5-b85d-08002789d050"
],
"subscribers": [
"b64752a6-1a34-6548-0db7-3f3faf34916b",
"mike.johnson@example.com"
]
}
Name | Data Type | Reference | Description | |
---|---|---|---|---|
campaign_id | string(38) | Campaign ID | ||
html_content | boolean | HTML Content | ||
status | integer(3) | campaign_status | Campaign Status | |
create_time | ISO8601 | Time of Creation | ||
source | integer(3) | campaign_source | Source | |
title | string(100) | Campaign Title | ||
send_from | ISO8601 | Send From | ||
send_to | ISO8601 | Send To | ||
settings | array | Settings | ||
settings: | subject | array | Subject | |
settings: | subject: subject | string(100) | Subject | |
settings: | subject: record_status | integer | record_status | Record status |
settings: | sender | array | Sender | |
settings: | sender: email | string(100) | Sender Email | |
settings: | sender: name | string(100) | Sender Name | |
settings: | sender: record_status | integer | record_status | Record status |
settings: | folder | array | Folder | |
settings: | folder: folder_id | integer | Folder ID | |
settings: | folder: record_status | integer | record_status | Record_status |
settings: | plan_time | ISO8601 | Scheduled Time | |
lists | array | Distribution Lists | ||
lists: | list_id | string(38) | List ID | |
lists: | record_status | integer(3) | record_status | Body |
subscribers | array | Subscribers | ||
subscribers: | email_id | string(38) | Email ID | |
subscribers: | string(100) | Email address | ||
subscribers: | record_status | integer(3) | record_status | Body |
content | array | Content | ||
content: | body | string | Body | |
content: | record_status | integer(3) | record_status | Record Status |
Code | Status | Example Body |
---|---|---|
200 | OK |
|