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
subscription_filter	JSON object	Push example: "subscription_filter": {    "subscription_id": "CAREFULWITHTHATAXE",    "provider": "Chrome",    "not_strict": true } Email example: "subscription_filter": {    "email": "example@example.com",    "not_strict": true } SMS example: "subscription_filter": {    "phone": "+79106135133",    "not_strict": false }	No	Selects a profile's subscription to send message Not used if custom_request is set. not_strict determines what to do when a certain subscription is not found. If "true" — another fitting subscription will be used instead.
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	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

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

Request example (matching by email)

JSON

{
    "token": "abcdefghijklmnqrstuvwxyz",
    "trigger_id": 96,
    "format": "json",
    "skip_triggers": false,
    "detect_geo": true,
    "matching": "email",
    "data": [
        {
            "data": {
                "_fname": "Lili",
                "_lname": "Collins",
                "email": "example@example.com",
                "phones": "+79000000000",
                "subscriptions": [
                    {
                        "channel": "email",
                        "email": "example@example.com",
                        "priority": 0,
                        "resource_id": 21,
                        "status": 0
                    }
                ]
            }
        },
        {
            "data": {
                "_fname": "Eva",
                "_lname": "Collins",
                "email": "example@example.com",
                "phones": "+79000000001",
                "subscriptions": [
                    {
                        "channel": "email",
                        "email": "example@example.com",
                        "priority": 0,
                        "resource_id": 21,
                        "status": 0
                    }
                ]
            }
        }
    ]
}

XML

<xml>
    <token>abcdefghijklmnqrstuvwxyz</token>
    <trigger_id>96</trigger_id>
    <format>xml</format>
    <skip_triggers>false</skip_triggers>
    <detect_geo>true</detect_geo>
    <matching>email</matching>
<data>
    <_fname>Lili</_fname>
    <_lname>Collins</_lname>
    <email>example@example.com</email>
    <phones>+79000000000</phones>
        <subscriptions>
            <channel>email</channel>
            <email>example@example.com</email>
            <priority>0</priority>
            <resource_id>21</resource_id>
            <status>0</status>
        </subscriptions>
</data>
<data>
    <_fname>Eva</_fname>
    <_lname>Collins</_lname>
    <email>example@example.com</email>
    <phones>+79000000001</phones>
    <subscriptions>
        <channel>email</channel>
        <email>example@example.com</email>
        <priority>0</priority>
        <resource_id>21</resource_id>
        <status>0</status>
    </subscriptions>
</data>
</xml>

Request example (matching by custom field)

JSON

{
    "token": "abcdefghijklmnqrstuvwxyz",
    "trigger_id": 85,
    "format": "json",
    "skip_triggers": false,
    "detect_geo": true,
    "matching": "custom",
    "field_name": "Custom_ID",
    "data": [
        {
            "data": {
                "_fname": "Adama",
                "_lname": "Fuller",
                "email": "example@example.com,
                "phones": "+79000000000",
                "Custom_ID": "345",
                "subscriptions": [
                    {
                        "channel": "email",
                        "email": "example@example.com",
                        "priority": 0,
                        "resource_id": 21,
                        "status": 0
                    }
                ]
            }
        },
        {
            "data": {
                "_fname": "Eva",
                "_lname": "Fuller",
                "email": "example@example.com",
                "phones": "+79000000001",
                "Custom_ID": "567",
                "subscriptions": [
                    {
                        "channel": "email",
                        "email": "example@example.com",
                        "priority": 0,
                        "resource_id": 21,
                        "status": 0
                    }
                ]
            }
        }
    ]
}

XML

<xml>
    <token>abcdefghijklmnqrstuvwxyz</token>
    <trigger_id>85</trigger_id>
    <format>xml</format>
    <skip_triggers>false</skip_triggers>
    <detect_geo>true</detect_geo>
    <matching>custom</matching>
    <field_name>custom_field</field_name>
    <data>
        <_fname>Irina</_fname>
        <_lname>Depp</_lname>
        <email>example@example.com</email>
        <phones>+79000000000</phones>
        <custom_field>343</custom_field>
        <subscriptions array='true'>
            <channel>email</channel>
            <email>example@example.com</email>
            <priority>0</priority>
            <resource_id>21</resource_id>
            <status>0</status>
        </subscriptions>
    </data>
    <data>
        <_fname>Will</_fname>
        <_lname>Depp</_lname>
        <email>example@example.com</email>
        <phones>+79000000001</phones>
        <custom_field>560</custom_field>
        <subscriptions array='true'>
            <channel>email</channel>
            <email>example@example.com</email>
            <priority>0</priority>
            <resource_id>21</resource_id>
            <status>0</status>
        </subscriptions>
    </data>
</xml>

Response example

JSON

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

XML

<xml>
   <error>0</error>
   <error_text>Successful operation</error_text>
   <result>
      <element>
         <profile_id>602103d65ae47a3bc65d5d83</profile_id>
      </element>
      <element>
         <profile_id>601ec71c5ae47a15d1c9b472</profile_id>
      </element>
   </result>
</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_debug>http: request body too large</error_debug>
   <error_text>"Invalid request"</error_text>
</xml>