Task for bulk profiles import + trigger launch

Description

Add or update multiple profiles and then send a trigger mailing.

This request is a batch version of the Profile import + trigger mailing launch request.

Returns a response with the task id, without waiting for completion.

note

The request body size is limited by default to 10 Mb, exception for files — 100 Mb.

Data field rules

The rules apply to the data object inside each element of the data array.

• The field value must be valid for the field type: numeric fields accept a number, "list" fields accept a variant name from the list or its ordinal number, etc. If the value does not match the field type (for example, a string that is not in the list of variants is passed to a list field), the request returns an error. Value formats for custom fields are listed in the Custom field value formats section.
• Only the fields explicitly passed in the data object inside each element of the data array are updated. If some profile fields should not change, do not pass them in the request.
• Each profile in the data array is processed independently: if a field value in one profile fails validation, that profile is not imported and not sent to the trigger campaign, while the remaining profiles are processed. The error for this profile is reflected in the task result.
• For more flexible field value management, use database fields functional update.

Request URL

Метод: POST

http://example.com/api/v1.1/campaigns/triggers/import_and_start_batch_task

Request parameters

Parameters	Type	Example	Required	Description
Profile import
data	JSON object	[    {       "data": {          "_fname": "John",          "_lname": "Lambert",          "email": "profile4@example.com",          "phones": "+790000000000"       }    },    {       "data": {          "_fname": "Tom",          "_lname": "Hard",          "email": "profile3@example.com",          "phones": "+790000000001"       }    } ]	Yes	Profile fields data
expiration	string	"2026-02-22T21:00:00Z"	No	Message expiration date in RFC3339 format, after which it will be removed from the queue and a delivery failure event will be recorded
skip_triggers	bool	true	No	Skip trigger events. By default – false
skip_invalid_subscriptions	bool	true	No	Skip invalid subscriptions By default – false
detect_geo	bool	true	No	Detect location by _regip or _ip from data object
Profile matching mode
matching	string	"email" "email_profile" "phone" "profile_id" "custom"	No, if matched by email from profile or subscriptions	Profile matching mode By default - email
email	string	"john@example.com"	"matching":"email" - both profile data and subscriptions "matching":"email_profile" - profile data only	Email address
phone	string	"+79000000000"	"matching":"phone"	Phone number
profile_id	string	"abcdefghijklmnqrstuvwxyz"	"matching":"profile_id"	Profile ID
field_name	string	"CRM_ID"	"matching":"custom"	Custom profile data field name
field_value	int/string	"123420"	"matching":"custom"	Custom profile data field value. tip Searching by combination of tags is available for tag type profile fields. Values are recorded as a string: "tag-1, tag-2".
resource_id	int	24	No	Resource ID for email and phone matching
Trigger launch
trigger_id	int	13	Yes	Trigger mailing ID
custom_data	JSON object	{ "sending_time": "12:31:12" }	No	Data used for integration Action hooks
content	JSON object	{ "page": "registration_form" }	No	Data you can use in a message template using {apicontent.fieldname} variable
attach	JSON objects array	{ "data": "data:text/csv;base64,SEVMTE8K", "name": "Attach.txt" }	No	A file you can attach to an Email message

Response parameters

Параметр	Тип	Описание
error_text	string	Текст ошибки
error	int	Код ошибки
task_id	string	Идентификатор задачи

Request example (matching by email)

JSON

{
    "matching": "email",
    "data": [
        {
            "data": {
                "_fname": "Victoria",
                "_lname": " Beckham",
                "email": "example1@example.com",
                "phones": "+79000000000",
                "subscriptions": [
                    {
                        "channel": "email",
                        "email": "example2@example.com",
                        "resource_id": 21
                    },
                    {
                        "channel": "phone",
                        "phone": "+79000005478",
                        "resource_id": 20
                    }
                ]
            }
        },
        {
            "data": {
                "_fname": "David",
                "_lname": " Beckham",
                "email": "example3@example.com",
                "phones": "+79000000001",
                "subscriptions": [
                    {
                        "channel": "email",
                        "email": "example14@example.com",
                        "resource_id": 21
                    },
                    {
                        "channel": "phone",
                        "phone": "+79000000000",
                        "resource_id": 20
                    }
                ]
            }
        }
    ],
    "trigger_id": 96,
    "timeout": {
        "days": 0,
        "hours": 0,
        "minutes": 5
    },
    "content": {
        "page": "registration_form"
    },
    "attach": [
        {
            "data": "data:text/csv;base64,5LuK5pel44GvCg==",
            "name": "Attach.txt"
        }
    ]
}

XML

<xml>
    <matching>email</matching>
    <data>
        <_fname>Brooklyn</_fname>
        <_lname>Beckham</_lname>
        <email>example3@example.com</email>
        <phones>+79000849376</phones>
        <subscriptions>
            <channel>email</channel>
            <email>example9@example.com</email>
            <resource_id>21</resource_id>
        </subscriptions>
        <subscriptions>
            <channel>phone</channel>
            <phone>+79000005475</phone>
            <resource_id>20</resource_id>
        </subscriptions>
    </data>
    <data>
        <_fname>Romeo</_fname>
        <_lname>Beckham</_lname>
        <email>example32@example.com</email>
        <phones>+79000000651</phones>
        <subscriptions>
            <channel>email</channel>
            <email>@example.com</email>
            <resource_id>21</resource_id>
        </subscriptions>
        <subscriptions>
            <channel>phone</channel>
            <phone>+79000880000</phone>
            <resource_id>20</resource_id>
        </subscriptions>
    </data>
    <trigger_id>96</trigger_id>
    <timeout>
        <days>0</days>
        <hours>0</hours>
        <minutes>5</minutes>
    </timeout>
    <content>
        <page>registration_form</page>
    </content>
    <attach array='true'>
        <data>data:text/csv;base64,5LuK5pel44GvCg==</data>
        <name>Attach.txt</name>
    </attach>
</xml>

Request example (matching by custom field)

JSON

{
    "trigger_id": 96,
    "format": "json",
    "skip_triggers": false,
    "detect_geo": true,
    "matching": "custom",
    "field_name": "Custom_id",
    "data": [
        {
            "data": {
                "_fname": "Tom",
                "_lname": "Cruise",
                "email": "example@example.com",
                "phones": "+79000000000",
                "Custom_id": "0002"
            }
        },
        {
            "data": {
                "_fname": "Lili",
                "_lname": "Hard",
                "email": "example@example.com",
                "phones": "+79000000001",
                "Custom_id": "0001"
            }
        }
    ]
}

XML

<xml>
    <trigger_id>96</trigger_id>
    <format>xml</format>
    <skip_triggers>false</skip_triggers>
    <detect_geo>true</detect_geo>
    <matching>custom</matching>
    <field_name>Custom_ID</field_name>
    <data>
        <_fname>Viola</_fname>
        <_lname>Lambert</_lname>
        <email>example@example.com</email>
        <phones>+79000000000</phones>
        <Custom_ID>0002</Custom_ID>
    </data>
    <data>
        <_fname>Will</_fname>
        <_lname>Hard</_lname>
        <email>example@example.com</email>
        <phones>+79000000001</phones>
        <Custom_ID>0001</Custom_ID>
    </data>
</xml>

Response example

JSON

{
    "error": 0,
    "error_text": "Successful operation",
    "task_id": "1c1a5861-6d4c-4d6f-bd6a-3ca4f46b217d"
}

XML

<xml>
  <error>0</error>
  <error_text>Successful operation</error_text>
  <task_id>30421978-7f6d-4f39-913f-fb6cad8e2477</task_id>
</xml>

Response example when a request constraint is triggered

JSON

{
	"error":400,
	"error_debug":"http: request body too large",
	"error_text":"Invalid request"
}

XML

<xml>
    <error>400</error>
    <error_text>Invalid request</error_text>
</xml>

Checking task status

Request URL

Method: POST

https://example.com/api/v1.1/tasks/status

Request parameters

Parameter	Type	Example	Required	Description
task_id	string	"task_b2f9fk6a-2479-4a63-b592-f15d4e3b69c5"	Да	Task ID

Request example

JSON

{
    "task_id": "task_b2f9fk6a-2479-4a63-b592-f15d4e3b69c5"        
}

XML

<xml>
    <task_id>d521abe0-1abf-4e1d-b247-a790be66a424</task_id>
</xml>

Response example

JSON

{
    "data": {
        "status": "completed",
        "progress": 100,
        "result": {
            "error": 0,
            "error_text": "",
            "result": [
                {
                    "profile_id": "61e947333f62fc26d384452c"
                },
                {
                    "profile_id": "61e947333f62fc26d384452e"
                }
            ]
        }
    },
    "error": 0,
    "error_text": "Successful operation"
}

XML

<xml>
    <data>
        <progress>100</progress>
        <result>
            <captured>0</captured>
            <errors/>
            <status>ok</status>
        </result>
        <status>completed</status>
    </data>
    <error>0</error>
    <error_text>Successful operation</error_text>
</xml>