Page tree

Versions Compared

Key

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


SEO Metadata

Check out the API to import a subscriber profile and send it straight to your marketing automation scenario.

Table of Contents

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

ParameterTypeExampleRequiredDescription
tokenstring"abcdefghijklmnqrstuvwxyz"YesAPI token
formatstring"json"NoData format (by default - "json")
contentJSON-object{}NoAdditional content for API content filter node
and template apicontent variables
workflow_idInt1YesWorklow identifier
matchingString"email"YesProfile matching mode
profile_idString
"5f19953a03e4227216278ba4"
*Import: matching fields
emailString
"importStart9219@example.com"
*Import: matching fields
phoneString"+79001234567"*Import: matching fields
field_nameString"CRM_ID"*Import: matching fields
field_valueAny"12345"*Import: matching fields
dataObject


Code Block
{ "_fname": "John", "_lname": "Doe" }


No

Import: Profile fields data

skip_triggersBooltrueNo

Import options: skip triggers and workflows activated by import and update actions

skip_invalid_subscriptionsBooltrueNo

Import options: skip invalid subscriptions

detect_geoBooltrueNo

Import options: detect geolocation by IP

contentObject


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

attacharray of {name, flie_key, data, mimetype}
No

Trigger options: attach files to message

Request example

Import one customer profile and engage it in scenario.

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

Response example

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

Response parameters

ParameterTypeDescription
errorintError code
error_textstringError text
profile_idstringProfile identifier

Service responses

CodeDescription
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