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

JSON

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

XML

<xml>
    <token>abcdefghijklmnqrstuvwxyz</token>
    <id>15</id>
</xml>

Response example

JSON

{
    "data": {
        "name": "Regular campaign name",
        "is_active": true,
        "data_id": 2,
        "data_type": "segment",
        "content": [
            {
                "subject": "Hi!",
                "from_email": "broadcast@altcraft.com",
                "from_name": "",
                "replyto_email": "broadcast@altcraft.com",
                "replyto_name": "",
                "message_id": 15
            }
        ],
        "send_channel": "email",
        "channel": "email",
        "resource_id": 20,
        "subid": "",
        "limit": 10,
        "aglimit_count": 0,
        "aglimit_percent": 0,
        "start_schedule": {
            "start_mins": [
                10
            ],
            "start_hours": [
                12
            ],
            "start_mdays": [],
            "start_wdays": [],
            "start_months": [],
            "start_years": [],
            "tz": "",
            "profile": false,
            "losers": false
        },
        "for_confirm": false,
        "policy_id": 0,
        "description": "",
        "virtual_sender_id": 1,
        "is_random_tracking_prefix": false,
        "custom_tracking_domains": [
            "trk.example.com",
            "trk.example.org"
        ],
        "watcher_list_id": 0,
        "watcher_limit": 0,
        "blind_carbon_copy": [],
        "unconditional_sending": false,
        "skip_unique_checking": false,
        "sub_cats_filter": [],
        "sub_fields_filter": null,
        "id": 15,
        "updated_user": "roman",
        "update_time": "2024-04-03T15:35:54.024Z"
    },
    "error": 0,
    "error_text": "Successful operation"
}

XML

<xml>
    <data>
        <aglimit_count>0</aglimit_count>
        <aglimit_percent>0</aglimit_percent>
        <blind_carbon_copy/>
        <channel>"email"</channel>
        <content>
            <from_email>"broadcast@altcraft.com"</from_email>
            <from_name>""</from_name>
            <message_id>15</message_id>
            <replyto_email>"broadcast@altcraft.com"</replyto_email>
            <replyto_name>""</replyto_name>
            <subject>"Hi!"</subject>
        </content>
        <custom_tracking_domains>"trk.example.com"</custom_tracking_domains>
        <custom_tracking_domains>"trk.example.org"</custom_tracking_domains>
        <data_id>2</data_id>
        <data_type>"segment"</data_type>
        <description>""</description>
        <for_confirm>false</for_confirm>
        <id>15</id>
        <is_active>false</is_active>
        <is_random_tracking_prefix>false</is_random_tracking_prefix>
        <limit>10</limit>
        <name>"Regular campaign name"</name>
        <policy_id>0</policy_id>
        <push_sending_mode>"fanout"</push_sending_mode>
        <resource_id>20</resource_id>
        <send_channel>"email"</send_channel>
        <skip_unique_checking>false</skip_unique_checking>
        <start_schedule>
            <losers>false</losers>
            <profile>false</profile>
            <start_hours>12</start_hours>
            <start_mdays/>
            <start_mins>10</start_mins>
            <start_months/>
            <start_wdays/>
            <start_years/>
            <tz>""</tz>
        </start_schedule>
        <sub_cats_filter/>
        <sub_fields_filter/>
        <subid>""</subid>
        <unconditional_sending>false</unconditional_sending>
        <update_time>"2024-05-20T09:17:53.326Z"</update_time>
        <updated_user>"roman"</updated_user>
        <virtual_sender_id>1</virtual_sender_id>
        <watcher_limit>0</watcher_limit>
        <watcher_list_id>0</watcher_list_id>
    </data>
    <error>0</error>
    <error_text>Successful operation</error_text>
</xml>

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)