Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

ParameterTypeExampleRequiredDescription
tokenstring"abcdefghijklmnqrstuvwxyz"YesAPI token
formatstring"csv"NoResponse data format.
By default – json
idint12YesWorkflow ID
contentJSON-object{}No

Additional

content for API content filter node
and template apicontent variables

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.

Tip
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:

Code Block
"subscription_filter": {
"email": "example@example.com",
"phone": "+79106135133",
"subscription_id": "CAREFULWITHTHATAXE",
"provider": "Chrome",
"not_strict": true
}

Email example:

Code Block
"subscription_filter": {
"email": "example@example.com",
"not_strict": true
}

Sms example:

Code Block
"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.

...