Bulk profiles import + trigger campaign launch

Description

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

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

note

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

Request URL

Method: POST

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

Request parameters

Parameters	Type	Example	Required	Description
Profile import
token	string	"abcdefghijklmnqrstuvwxyz"	Yes	API token
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
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 campaign ID
timeout	JSON object	{ "days": 0, "hours": 0, "minutes": 5 }	No	Trigger start timeout. Specify the days, hours, and minutes to set the timeout period.
custom_data	JSON object	{ "sending_time": "12:31:12" }	No	Add some data to be used in Action hooks. The parameter can be passed either at the root of the request or separately in each data object.
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

Parameter	Type	Description
error_text	string	Error text
error	int	Error code
result	array	IDs of successfully imported profiles

Request example (matching by email)

{
    "token": "abcdefghijklmnqrstuvwxyz",
    "trigger_id": 8,
    "format": "json",
    "skip_triggers": false,
    "detect_geo": true,
    "matching": "email",
    "timeout": {
        "days": 0,
        "hours": 0,
        "minutes": 5
    }, 
    "data": [
        {
            "data": {
                "_fname": "John",
                "_lname": "Lambert",
                "email": "profile4@example.com",
                "phones": "+790000000000"
                }
        },
        {
            "data" : {
                "_fname": "Tom",
                "_lname": "Hard",
                "email": "profile3@example.com",
                "phones": "+790000000001"
            }
        }
    ]
}

Request example (matching by custom field)

{
	"token": "abcdefghijklmnqrstuvwxyz",
	"trigger_id": 455,
	"format": "json",
	"skip_triggers": false,
	"detect_geo": true,
	"matching": "custom",
	"field_name": "New_field_1",
	"data": [
		{
			"data": {
				"_fname": "NUMBER1",
				"_lname": "Lambert",
				"email": "profile01@example.com",
				"phones": "+790000000000",
				"New_field_1" : "0002"
			}
		},
		{
			"data" : {
				"_fname": "NUMBER2",
				"_lname": "Hard",
				"email": "profile02@example.com",
				"phones": "+790000000001",
				"New_field_1" : "0001"
			}
		}
	]
}

Response example

{
	"error": 0,
	"error_text": "Successful operation",
	"result": [
		{
			"profile_id": "602103d65ae47a3bc65d5d83"
		},
		{
			"profile_id": "601ec71c5ae47a15d1c9b472"
		}
	]
}

Response example when a request constraint is triggered

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