Get regular campaign information

Description

Retrieves a regular campaign detailed information.

Request URL

Method: POST

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

Request parameters

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

Request example

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

Response example

{
  "data": {
    "id": 4428,
    "name": "Regular campaign name",
    "is_active": false,
    "data_id": 2416,
    "data_type": "segment",
    "content": [
      {
        "subject": "Hello",
        "from_email": "",
        "from_name": "",
        "replyto_email": "",
        "replyto_name": "",
        "message_id": 4
      }
    ],
    "content_type": "",
    "send_channel": "email",
    "channel": "email",
    "resource_id": 1,
    "subid": "api_campaign",
    "limit": 0,
    "aglimit_count": 0,
    "aglimit_percent": 0,
    "start_schedule": {
      "start_mins": [ 0 ],
      "start_hours": [ 0 ],
      "start_mdays": [ 1 ],
      "start_wdays": [],
      "start_months": [ 12 ],
      "start_years": [ 2016 ]
    },
    "virtual_sender_id": 98,
    "is_random_tracking_prefix": false,
    "custom_tracking_domains": [],
    "watcher_list_id": 0,
    "watcher_limit": 0
  },
  "error": 0,
  "error_text": "Successful operation"
}

Response parameters

Parameter	Type	Description
error	int	Error code
error_text	string	Error text
id	int	Campaign ID
name	string	Campaign name
is_active	bool	Campaign active flag
resource_id	int	Resource ID
data_id	int	Audience source ID
data_type	string	Audience source type
content	JSON array	Message template object
send_channel	string	Sending channel
channel	string	Channel
for_confirm	bool	Messages with opt-in link flag
subid	string	Campaign SubID
start_schedule	JSON object	Start schedule object
limit	int	Campaign cycle limitation
aglimit_count	int	Increase limit each cycle - number
agllimit_percent	float	Increase limit each cycle - percent
policy_id	int	Sending policy ID
push_sending_mode	string	Push notification sending mode (push channels only)
descr	string	Campaign description
Smart settings
virtual_sender_id	int	Virtual sender ID (Smart accounts)
is_random_tracking_prefix	bool	Random tracking domain prefix (Smart accounts)
custom_tracking_domains	JSON array	Tracking domains list (Smart accounts)
blind_carbon_copy	JSON array	Hidden copy email addresses (Smart accounts)
unconditional_sending	bool	Send messages regardless of subscription status (Smart accounts)
watcher_list_id	int	Campaign watchers database ID (Smart accounts)
watcher_limit	int	Watchers limit (Smart accounts)