Skip to content
/
Import Marketing Campaign...

Import Marketing Campaign Template

Tool name: import-automation-template

Imports an automation template from a shared link or catalogue URI, creating paused automations and creating or mapping their tags, fields, emails and outbounds. Sends nothing until activation. Created objects remain without undo; outbound limits, duplicate names or invalid mappings refuse before writing. Read it with get-automation-template first and settle name and mappings with the user.

Input schema

automationNamenull or string, [ 1 .. 250 ] characters

Name of the new automation; omitted takes the template name. Smart import only

Default:null
objectPrefixnull or string, <= 100 characters

Prefix put before the name of every created object; omitted means none. Smart import only

Default:null
metaLabelsArray of strings, <= 100 items
Default:null
mappingsArray of objects, <= 500 items
Default:null
accountIdnull or integer, >= 1

User ID of the account; omit for the account of the access token

Default:null
Input example
{
  "templateLink": "string",
  "automationName": null,
  "objectPrefix": null,
  "metaLabels": null,
  "mappings": null,
  "accountId": null
}

Output schema

accountIdintegerrequired
automationIdintegerrequired
automationNamestringrequired
editUrlstringrequired
createdArray of objectsrequired
mappedArray of objectsrequired
failedArray of objectsrequired
notTransferableArray of stringsrequired
Output example
{
  "accountId": 0,
  "automationId": 0,
  "automationName": "string",
  "editUrl": "string",
  "created": [
    {
      "type": "automation",
      "incomingId": "string",
      "incomingName": "string",
      "id": "string",
      "name": "string"
    }
  ],
  "mapped": [
    {
      "type": "automation",
      "incomingId": "string",
      "incomingName": "string",
      "id": "string",
      "name": "string"
    }
  ],
  "failed": [
    {
      "type": "automation",
      "incomingId": "string",
      "incomingName": "string",
      "id": "string",
      "name": "string"
    }
  ],
  "notTransferable": [
    "string"
  ]
}