Skip to main content

Task for batch import and engaging profiles in the scenario

Description​

Adding or updating multiple profiles and then sending them to the scenario. Returns a response with the task id without waiting for execution.

note

The request body is limited by default to 10mb, exception: files are 100mb.

It is not recommended to transmit more than 10,000 profiles per request.

URL​

Method: POST

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

Request parameters​

ParameterTypeExampleRequiredDescription
tokenstring"abcdefghijklmnqrstuvwxyz"YesAPI token
formatstring"json"NoData format (by default - "json")
workflow_idInt1YesWorkflow identifier
matchingString"email"YesProfile matching mode.
By default – email.
profile_idString"5f19953a03e4227216278ba4""matching":"profile_id"Profile identifier
emailString"importStart9219@example.com""matching":"email" - from profile or subscriptions

"matching":"email_profile" - only from profile		Email
phoneString"+79001234567""matching":"phone"Phone number
field_nameString"CRM_ID""matching":"custom"The name of the custom profile field for search.
field_valueAny"12345""matching":"custom"The value of the custom profile field for search.

Search by combination of tags is available. Values are recorded as a string: "tag-1, tag-2".
dataObject
{
   "_fname": "John", 
   "_lname": "Doe" 
}
NoProfile data, including subscriptions
skip_triggersBooltrueNoSkip triggers and workflows activated by import and update actions
By default – false
skip_invalid_subscriptionsBooltrueNoSkip invalid subscriptions
By default – false
detect_geoBooltrueNoDetect geolocation by IP (it is detected by data from the fields _regip or _ip)
contentObject
"content":{
   "one": "My email = importStart9219@example.com",
   "two": "Timestamp: 1595512477",
   "three": "Three"
}
NoAdditional 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_dataJSON object
"custom_data": {
   "field": "value",
}
NoAdd some data to be used in Action hooks. The parameter can be passed either at the root of the request or separately in each data object.
attacharray of {name, flie_key, data, mimetype}
NoFile to attach to an Email message (only for Email triggers)
custom_requestJSON object
{
"email": {
  "$in": [
      "asd@dsfsd.com",
      "zxcv@sdfsd.com"
  ]
}
}
When no matching
specified		Custom MongoDB database query

Returned parameters​

ParameterTypeDescription
error_textstringError text
errorintError code
task_idstringTask identifier

Request example – "matching":"email"​

{
  "token": "abcdefghijklmnqrstuvwxyz",
  "workflow_id": 12,
  "matching": "email",
  "data": [
    {
      "data": {
        "_fname": "Herbert",
        "_lname": "Lambert",
        "email": "example@example.com",
        "phones": "+79862014852"
      }
    },
    {
      "data": {
        "_fname": "Bert",
        "_lname": "Lambert",
        "email": "example@example.com",
        "phones": "+79862014853"
      }
    }
  ]
}

Request example – "matching":"custom"​

{
    "token": "abcdefghijklmnqrstuvwxyz",
    "workflow_id": 12,
    "matching": "custom",
    "field_name": "New_field_7",
    "data": [
        {
            "data": {
                "_fname": "Kristina",
                "_lname": "Lambert",
                "email": "example@example.com",
                "phones": "+79568150395",
                "New_field_7": "00015"
            }
        },
        {
            "data": {
                "_fname": "Christopher",
                "_lname": "Lambert",
                "email": "example@example.com",
                "phones": "+79568150396",
                "New_field_7": "00016"
            }
        }
    ]
}

Response example​

{
  "error": 0,
  "error_text": "Successful operation",
  "task_id": "30421978-7f6d-4f39-913f-fb6cad8e2477"
}

Example of a response when a request restriction is triggered​

{
  "error": 400,
  "error_debug": "http: request body too large",
  "error_text": "Invalid request"
}

Checking the status of the task​

URL​

Method: POST

https://example.com/api/v1.1/tasks/status

Request parameters​

ParameterTypeExampleRequiredDescription
tokenstring"abcdefghijklmnopqrstuvwxyz"YesAPI token
task_idstring"task_b2f9fk6a-2479-4a63-b592-f15d4e3b69c5"YesTask ID

Request example​

{
  "token": "abcdefghijklmnqrstuvwxyz",
  "task_id": "task_b2f9fk6a-2479-4a63-b592-f15d4e3b69c5"        
}

Response example​

{
    "data": {
        "status": "completed",
        "progress": 100,
        "result": {
            "error": 0,
            "error_text": "",
            "result": [
                {
                    "profile_id": "61e947333f62fc26d384452c"
                },
                {
                    "profile_id": "61e947333f62fc26d384452e"
                }
            ]
        }
    },
    "error": 0,
    "error_text": "Successful operation"
}
Last updated on