Get campaign information

Description

Retrieves detailed campaign information.

Request URL

Method: POST

https://example.com/api/v1.1/campaigns/get

Request parameters

Parameter	Type	Example	Required	Description
token	string	"abcdefghijklmnqrstuvwxyz"	Yes	API token
format	string	"json"	No	Response data format By default – json
id	int	1	Yes	Campaign ID

request example

{
    "id": 1,
    "token": "abcdefghijklmnqrstuvwxyz"
}

Response example

{
    "data": {
        "content": [
            {
                "from_email": "",
                "from_name": "John",
                "message_id": 1,
                "replyto_email": "",
                "replyto_name": "",
                "subject": "Welcome!"
            },
            {
                "from_email": "",
                "from_name": "Jane",
                "message_id": 1,
                "replyto_email": "",
                "replyto_name": "",
                "subject": "Welcome!"
            }
        ],
        "data_id": 1,
        "data_type": "list",
        "id": 1,
		"update_time": "2010-10-20T00:00:00Z",
        "updated_user": "John",
		"is_active": false,
        "is_completed": false,
        "name": "Splittest",
        "resource_id": 1,
        "send_email_content": true,
        "send_push_content": false,
        "send_sms_content": false,
        "status": "Inactive",
        "subid": "API",
        "type": "splittest",
        "virtual_sender_id": 1
    },
    "error": 0,
    "error_text": "Successful operation"
}

Response parameters

Parameters	Type	Description
error	int	Error code
error_text	string	Error text
content	JSON array	Message templates list
data_id	int	Audience source ID
data_type	string	Audience source type
id	int	Campaign ID
update_time	string	Date the campaign was last edited
updated_user	string	Name of the user who edited the campaign
is_active	bool	Campaign active flag
is_completed	bool	Campaign finished flag
name	string	Campaign name
resource_id	int	Resource ID
send_email_content	bool	Email channel active
send_push_content	bool	Push channel active
send_sms_content	bool	SMS channel active
push_sending_mode	string	Push notification sending mode (push channels only)
for_confirm	bool	Messages with opt-in link flag
status	string	Campaign status
subid	string	Campaign SubID
type	string	Campaign type
virtual_sender_id	int	Virtual sender ID
descr	string	Campaign description