Page tree
Skip to end of metadata
Go to start of metadata

Description

Engages a customer profile in scenario.

Request URL

Method: POST

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

Request parameters

ParameterTypeExampleRequiredDescription
tokenstring"abcdefghijklmnqrstuvwxyz"YesAPI token
formatstring"csv"NoResponse data format.
By default – json
idint12YesWorkflow ID
contentJSON-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

attachJSON-массив

[]

NoAttaches file(s) to the request
Profile matching mode
matchingstring

"email"
"phone"
"profile_id"
"custom"

No, if matched by email

Profile matching mode

By default  - email

emailstring"john@example.com""matching":"email"Email address
phonestring"+79000000000""matching":"phone"Phone number
profile_idstring
"abcdefghijklmnqrstuvwxyz"
"matching":"profile_id"Profile ID
field_namestring

"CRM_ID"

"matching":"custom"Custom profile data field name
field_valueint/string"123420""matching":"custom"

Custom profile data field value.

Searching by combination of tags is available for tag type profile fields. Values are recorded as a string: "tag-1, tag-2".
resource_idint24No

Resource ID for email and
phone matching

subscription_filterJSON object

Push example:

"subscription_filter": {
"email": "example@example.com",
"phone": "+79106135133",
"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


Used along with custom, profile_id or custom_request profile matching. 


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

ParameterTypeDescription
errorintError code
error_textstringError text
  • No labels