Profile import + trigger campaign launch

Description

A new customer profile import followed by a trigger campaign launch.

URL

Method: POST

https://example.com/api/v1.1/campaigns/triggers/import_and_start

Request parameters

Parameters	Type	Example	Required	Description
Profile import
token	string	"abcdefghijklmnqrstuvwxyz"	Yes	API token
data	JSON object	{ "_fname": "John", "_lname": "Doe" }	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	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

Request example

JSON

{
   "token": "abcdefghijklmnqrstuvwxyz",
   "matching": "email",
   "email": "example@example.com",
   "detect_geo": true,
   "data": {
      "_fname": "Olly",
      "_lname": "Lambert",
      "email": "example@example.com",
      "phones": [
         "+79000000000"
      ],
      "_bdate": "1990-02-22T21:00:00Z",
      "custom_field": "custom_value",
      "subscriptions": [
         {
            "channel": "email",
            "email": "example@example.com",
            "resource_id": 21
         },
         {
            "channel": "phone",
            "phone": "+79000000000",
            "resource_id": 21
         }
      ]
   },
   "trigger_id": 96,
   "timeout": {
         "days": 0,
         "hours": 0,
         "minutes": 5
   },    
   "custom_data": {
      "sending_time": "12:31:12"
   },
     "attach": [
      {
         "data": "data:text/csv;base64,5LuK5pel44GvCg==",
         "name": "Attach.txt"
      }
   ]
}

XML

<xml>
    <token>abcdefghijklmnqrstuvwxyz</token>
    <matching>email</matching>
    <email>example@example.com</email>
    <detect_geo>true</detect_geo>
    <data>
        <_fname>Garry</_fname>
        <_lname>Sallivan</_lname>
        <_bdate>1990-02-22T21:00:00Z</_bdate>
        <email>example@example.com</email>
        <phones array='true'>+79000000027</phones>
        <custom_field>custom_value</custom_field>
        <subscriptions>
            <channel>email</channel>
            <email>testtriggers90@example.com</email>
            <resource_id>21</resource_id>
        </subscriptions>
        <subscriptions>
            <channel>phone</channel>
            <phone>+79000000780</phone>
            <resource_id>21</resource_id>
        </subscriptions>
    </data>
    <trigger_id>96</trigger_id>
    <timeout>
        <days>0</days>
        <hours>0</hours>
        <minutes>5</minutes>
    </timeout>
    <custom_data>
        <sending_time>12:31:12</sending_time>
    </custom_data>
    <attach array='true'>
        <data>data:text/csv;base64,5LuK5pel44GvCg==</data>
        <name>Attach.txt</name>
    </attach>
</xml>

Response example

JSON

{
    "error": 0,
    "error_text": "",
    "profile_id": "54759eb3c090d83494e2d804"
}

XML

<xml>
    <error>0</error>
    <error_text>Successful operation</error_text>
    <profile_id>660feee02984cf021df478f3</profile_id>
</xml>

caution

Subscription to the Resource that is used by the trigger campaign has to be sent within profile data object. If not — the following mistake will be sent back:

{
    "error": 400,
    "error_text": "No active subscriptions passed for trigger resource"
}

Response parameters

Parameter	Type	Description
error	int	Error code
error_text	string	Error description
profile_id	string	Imported profile ID