Get regular campaigns list

Description

Retrieves regular campaigns list.

Request URL

Method: POST

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

Request parameters

Parameter	Type	Example	Required	Description
token	string	"abcdefghijklmnqrstuvwxyz"	Yes	API token
from_id	int	11768	No	The first campaign in the list ID. By default –1
limit	int	10	No	Campaigns list limit. By default – 1000
format	string	"json"	No	Response data format. By default – json
is_active	bool	true	No	Retrieve active campaigns only
ui_tags	[]String	[ "tag1", "tag2" ]	No	List of tags for search By default – []
groups	[]String	[ "group1", "group2" ]	No	List of access groups By default – []
groups_id	[]int	[ 0, 1 ]	No	List of group IDs By default – []

Request example

{
    "limit": 2,
    "token": "abcdefghijklmnqrstuvwxyz"
}

Response example

{
    "data": [
        {
            "id": 11929,
            "is_active": true,
            "name": "Regular 2",
            "type": "regular"
        },
        {
            "id": 11930,
            "is_active": false,
            "name": "Regular 1",
            "type": "regular"
        }
    ],
    "error": 0,
    "error_text": "Successful operation",
    "total_count": 5470
}

Response parameters

Parameter	Type	Description
error	int	Error code
error_text	string	Error text
id	int	Campaign ID
name	string	Campaign name
type	string	Campaign type
is_active	bool	Campaign active flag
for_confirm	bool	Messages with opt-in link flag
total_count	int	Total campaign count
ui_tags	[]String	Tag list
groups	[]String	Group list