Engage profile in scenario
Description
Engages a customer profile in the scenario.
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 | |
custom_data | JSON object |
| No | Add some data to be used in Action hooks. |
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 |
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": {Email example: "subscription_filter": {SMS example: "subscription_filter": { | 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.
{
"token": "abcdefghijklmnqrstuvwxyz",
"id": 5511,
"matching": "profile_id",
"profile_id": "5a74876369d42613b31947b8"
}
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.
{
"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"
},
"id": 5511,
"token": "abcdefghijklmnqrstuvwxyz"
}
Response example
{
"error": 0,
"error_text": "Successful operation"
}
Response parameters
Parameter | Type | Description |
---|---|---|
error | int | Error code |
error_text | string | Error text |