Engage profile in scenario

Description

Engages a customer profile in scenario.

tip

When you launch the scenario using the API, the profiles will enter the "Default" start node.

Request URL

Method: POST

https://example.com/api/v1.1/workflows/start

Request parameters

Parameter	Type	Example	Required	Description
token	string	"abcdefghijklmnqrstuvwxyz"	Yes	API token
format	string	"csv"	No	Response data format. By default – json
id	int	12	Yes	Workflow ID
content	JSON-object		No	Additional data to be used in the message template as {apicontent.fieldname} variable. The variable can be used in the "API call" and "API content filter" nodes
attach	JSON-массив	[]	No	Attaches file(s) to the request
Profile matching mode
matching	string	"email" "phone" "profile_id" "custom"	No, if matched by email	Profile matching mode By default - email
email	string	"john@example.com"	"matching":"email"	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
custom_request	JSON object		When no matching specified	Custom MongoDB database query
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.

Request example 1

Engages a single profile matched by Profile ID.

JSON

{
  "token": "abcdefghijklmnqrstuvwxyz",
  "id": 11,
  "matching": "profile_id",
  "profile_id": "5a74876369d42613b31947b8"
}

XML

<xml>
  <token>abcdefghijklmnqrstuvwxyz</token>
  <id>11</id>
  <matching>profile_id</matching>
  <profile_id>5a74876369d42613b31947b8</profile_id>
</xml>

Request example 2

Overwrites message subject by placing "New videos on your favorite channels" for "{apicontent.email_title}" message variable value, if it is used in campaign node templates.

Attaches "日本.txt" and "US.txt" files and a content object to be used in API content filter query.

JSON

{
    "token": "abcdefghijklmnqrstuvwxyz",
    "id": 12,
    "matching": "profile_id",
    "profile_id": "66102b984a5d12bd6cc0912f",
    "attach": [
        {
            "data": "data:text/csv;base64,5LuK5pel44GvCg==",
            "name": "日本.txt"
        },
        {
            "data": "data:text/csv;base64,SEVMTE8K",
            "name": "US.txt"
        }
    ],
    "content": {
        "data_lines": [
            "Channel A",
            "Channel B"
        ],
        "email_title": "New videos on your favorite channels"
    }
}

XML

<xml>
  <token>abcdefghijklmnqrstuvwxyz</token>
  <id>12</id>
  <matching>profile_id</matching>
  <profile_id>661027b04a5d12bd6cc09125</profile_id>
  <attach>
    <data>data:text/csv;base64,5LuK5pel44GvCg==</data>
    <name>日本.txt</name>
  </attach>
  <attach>
    <data>data:text/csv;base64,SEVMTE8K</data>
    <name>US.txt</name>
  </attach>
  <content>
    <data_lines>Channel A</data_lines>
    <data_lines>Channel B</data_lines>
    <email_title>New videos on your favorite channels</email_title>
  </content>
</xml>

Response example

JSON

{
    "data": null,
    "error": 0,
    "error_text": "Successful operation"
}

XML

<xml>
    <data/>
    <error>0</error>
    <error_text>Successful operation</error_text>
</xml>

Response parameters

Parameter	Type	Description
error	int	Error code
error_text	string	Error text