Import and engage profile in scenario

Description

Use this request to import customer profile and engage it in scenario.

Request URL

Method: POST

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

Request parameters

Parameter	Type	Example	Required	Description
token	string	"abcdefghijklmnqrstuvwxyz"	Yes	API token
format	string	"json"	No	Data format (by default - "json")
content	JSON-object	{}	No	Additional content for API content filter node and template apicontent variables
workflow_id	Int	1	Yes	Worklow identifier
matching	String	"email"	Yes	Profile matching mode
profile_id	String	"5f19953a03e4227216278ba4"	*	Import: matching fields
email	String	"importStart9219@example.com"	*	Import: matching fields
phone	String	"+79001234567"	*	Import: matching fields
field_name	String	"CRM_ID"	*	Import: matching fields
field_value	Any	"12345"	*	Import: matching fields
data	Object	{    "_fname": "John",    "_lname": "Doe" }	No	Import: Profile fields data
skip_triggers	Bool	true	No	Import options: skip triggers and workflows activated by import and update actions
skip_invalid_subscriptions	Bool	true	No	Import options: skip invalid subscriptions
detect_geo	Bool	true	No	Import options: detect geolocation by IP
content	Object	"content":{    "one": "My email = importStart9219@example.com",    "two": "Timestamp: 1595512477",    "three": "Three" }	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	array of{name, flie_key, data, mimetype}		No	Trigger options: attach files to message

Request example

Import one customer profile and engage it in scenario.

JSON

{
  "token": "abcdefghkijlmnopqrstuv0123456789",
  "data": {
    "subscriptions": [
      {
        "email": "example001@example.com",
        "resource_id": 7
      }
    ]
  },
  "matching": "email",
  "email": "example001@example.com",
  "content": {
    "one": "My email = example001@example.com",
    "two": "Timestamp: 1595512477",
    "three": "Three"
  },
  "workflow_id": 12
}

XML

<xml>
  <token>abcdefghijklmnqrstuvwxyz</token>
  <data>
    <subscriptions array='true'>
      <email>example001@example.com</email>
      <resource_id>7</resource_id>
    </subscriptions>
  </data>
  <matching>email</matching>
  <email>example001@example.com</email>
  <content>
    <one>My email = example001@example.com</one>
    <two>Timestamp: 1595512477</two>
    <three>Three</three>
  </content>
  <workflow_id>12</workflow_id>
</xml>

Response example

JSON

{
  "error": 0,
  "error_text": "Successful operation",
  "profile_id": "5eeb54a2ce9448518e85fdad"
}

XML

<xml>
    <error>0</error>
    <error_text>Successful operation</error_text>
    <profile_id>6613c13a4a5d12bd6cc09156</profile_id>
</xml>

Response parameters

Parameter	Type	Description
error	int	Error code
error_text	string	Error text
profile_id	string	Profile identifier

Service responses

Code	Description
0	Operation is successful
400,450	Incorrect request
401	API token required
402	Tariff limit reached
403	No rights for this action
404	Object is not found in token vision zone
409	Other record with same unique attributes already exists
413	Database is not available in selected resource
415	Requested Content-Type is not supported
435	Ambiguous search, there are several objects with given attributes
441	Object belongs to another group
500	Internal service error
501	Method does not exist