Create automation from import

curl --request POST \
  --url https://automations-api.vortexiq.ai/v1/automations/imports/{importId}/automation \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "integration_id": 101,
  "name": "Daily product summary",
  "schedule": {
    "cadence": "manual"
  }
}
'

import requests

url = "https://automations-api.vortexiq.ai/v1/automations/imports/{importId}/automation"

payload = {
    "integration_id": 101,
    "name": "Daily product summary",
    "schedule": { "cadence": "manual" }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    integration_id: 101,
    name: 'Daily product summary',
    schedule: {cadence: 'manual'}
  })
};

fetch('https://automations-api.vortexiq.ai/v1/automations/imports/{importId}/automation', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://automations-api.vortexiq.ai/v1/automations/imports/{importId}/automation",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'integration_id' => 101,
    'name' => 'Daily product summary',
    'schedule' => [
        'cadence' => 'manual'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://automations-api.vortexiq.ai/v1/automations/imports/{importId}/automation"

	payload := strings.NewReader("{\n  \"integration_id\": 101,\n  \"name\": \"Daily product summary\",\n  \"schedule\": {\n    \"cadence\": \"manual\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://automations-api.vortexiq.ai/v1/automations/imports/{importId}/automation")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"integration_id\": 101,\n  \"name\": \"Daily product summary\",\n  \"schedule\": {\n    \"cadence\": \"manual\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://automations-api.vortexiq.ai/v1/automations/imports/{importId}/automation")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"integration_id\": 101,\n  \"name\": \"Daily product summary\",\n  \"schedule\": {\n    \"cadence\": \"manual\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "contract_version": 1,
  "data": {
    "automation": {
      "id": "01M520GX9NYKQHVAC43NBBRHH6",
      "version": 1,
      "kind": "workflow",
      "import_id": "01M520GX6YJ992K8Z6DHPJETKB",
      "template_id": "imported-workflow-shopify",
      "template_version": 1,
      "platform": "shopify",
      "integration_id": 101,
      "store_label": "Example Shopify store",
      "name": "Daily product summary",
      "state": "draft",
      "trigger": {
        "kind": "schedule"
      },
      "paused_by": null,
      "paused_reason": null,
      "inputs": {},
      "bindings": {},
      "plan_version": 1,
      "connections": [],
      "schedule": {
        "cadence": "manual",
        "run_at": null,
        "day_of_week": null,
        "day_of_month": null,
        "date": null,
        "days": null,
        "week_of_month": null
      },
      "timezone": "Europe/London",
      "spread_minutes": 9,
      "next_run_at": null,
      "last_run_at": null,
      "consecutive_failures": 0,
      "send_mode": "ask",
      "created_at": "2026-10-16T09:26:07.415Z",
      "updated_at": "2026-10-16T09:26:07.415Z",
      "created_by": 7,
      "created_via": "api-token",
      "api_client_id": "viq_auto_Ab12Cd34Ef56Gh78Ij90Kl12",
      "readiness": {
        "ready": true,
        "missing": [],
        "unconfigured": []
      }
    }
  }
}

{
  "success": false,
  "contract_version": 2,
  "message": "<string>",
  "code": "<string>",
  "errors": {}
}

{
  "success": false,
  "contract_version": 2,
  "message": "<string>",
  "code": "<string>",
  "errors": {}
}

{
  "success": false,
  "contract_version": 2,
  "message": "<string>",
  "code": "<string>",
  "errors": {}
}

{
  "success": false,
  "contract_version": 2,
  "message": "<string>",
  "code": "<string>",
  "errors": {}
}

{
  "success": false,
  "contract_version": 2,
  "message": "<string>",
  "code": "<string>",
  "errors": {}
}

Create automation from import

Set up an automation that runs an imported workflow (an n8n or Shopify Flow export) as your own, on one of your stores. The automation keeps its own copy of the workflow, so deleting the import later changes nothing. A workflow that starts when the store sends an event takes only schedule.cadence: manual, and is active at once.

Steps that send somewhere bind to your connections with bindings (see List destinations). An automation with a step still unbound is created as a draft, and stays one until you switch it on: once every step is bound (with Update automation), give it its schedule again with Update automation, or run it now; one that starts on a store event, with Resume automation. Answers 422 when a step is not supported, a binding is refused, or running imported workflows is not switched on for your organisation.

Needs the automations:write scope.

POST

automations

imports

{importId}

automation

Create automation from import

curl --request POST \
  --url https://automations-api.vortexiq.ai/v1/automations/imports/{importId}/automation \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "integration_id": 101,
  "name": "Daily product summary",
  "schedule": {
    "cadence": "manual"
  }
}
'

import requests

url = "https://automations-api.vortexiq.ai/v1/automations/imports/{importId}/automation"

payload = {
    "integration_id": 101,
    "name": "Daily product summary",
    "schedule": { "cadence": "manual" }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    integration_id: 101,
    name: 'Daily product summary',
    schedule: {cadence: 'manual'}
  })
};

fetch('https://automations-api.vortexiq.ai/v1/automations/imports/{importId}/automation', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://automations-api.vortexiq.ai/v1/automations/imports/{importId}/automation",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'integration_id' => 101,
    'name' => 'Daily product summary',
    'schedule' => [
        'cadence' => 'manual'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://automations-api.vortexiq.ai/v1/automations/imports/{importId}/automation"

	payload := strings.NewReader("{\n  \"integration_id\": 101,\n  \"name\": \"Daily product summary\",\n  \"schedule\": {\n    \"cadence\": \"manual\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://automations-api.vortexiq.ai/v1/automations/imports/{importId}/automation")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"integration_id\": 101,\n  \"name\": \"Daily product summary\",\n  \"schedule\": {\n    \"cadence\": \"manual\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://automations-api.vortexiq.ai/v1/automations/imports/{importId}/automation")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"integration_id\": 101,\n  \"name\": \"Daily product summary\",\n  \"schedule\": {\n    \"cadence\": \"manual\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "contract_version": 1,
  "data": {
    "automation": {
      "id": "01M520GX9NYKQHVAC43NBBRHH6",
      "version": 1,
      "kind": "workflow",
      "import_id": "01M520GX6YJ992K8Z6DHPJETKB",
      "template_id": "imported-workflow-shopify",
      "template_version": 1,
      "platform": "shopify",
      "integration_id": 101,
      "store_label": "Example Shopify store",
      "name": "Daily product summary",
      "state": "draft",
      "trigger": {
        "kind": "schedule"
      },
      "paused_by": null,
      "paused_reason": null,
      "inputs": {},
      "bindings": {},
      "plan_version": 1,
      "connections": [],
      "schedule": {
        "cadence": "manual",
        "run_at": null,
        "day_of_week": null,
        "day_of_month": null,
        "date": null,
        "days": null,
        "week_of_month": null
      },
      "timezone": "Europe/London",
      "spread_minutes": 9,
      "next_run_at": null,
      "last_run_at": null,
      "consecutive_failures": 0,
      "send_mode": "ask",
      "created_at": "2026-10-16T09:26:07.415Z",
      "updated_at": "2026-10-16T09:26:07.415Z",
      "created_by": 7,
      "created_via": "api-token",
      "api_client_id": "viq_auto_Ab12Cd34Ef56Gh78Ij90Kl12",
      "readiness": {
        "ready": true,
        "missing": [],
        "unconfigured": []
      }
    }
  }
}

{
  "success": false,
  "contract_version": 2,
  "message": "<string>",
  "code": "<string>",
  "errors": {}
}

{
  "success": false,
  "contract_version": 2,
  "message": "<string>",
  "code": "<string>",
  "errors": {}
}

{
  "success": false,
  "contract_version": 2,
  "message": "<string>",
  "code": "<string>",
  "errors": {}
}

{
  "success": false,
  "contract_version": 2,
  "message": "<string>",
  "code": "<string>",
  "errors": {}
}

{
  "success": false,
  "contract_version": 2,
  "message": "<string>",
  "code": "<string>",
  "errors": {}
}

Authorizations

Authorization

string

header

required

A bearer token from Login, sent as Authorization: Bearer <token>. Valid for 60 minutes; it acts as the person named at login, within their organisation, and never approves. Rotating or disabling the organisation's API credential ends every token made with it on its next call. See Authentication.

Path Parameters

importId

string

required

The import's id. A public id (a ULID).

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$

Body

application/json

integration_id

integer

required

The id of the store it reads (see List stores).

schedule

object

required

A workflow that starts on a store event (ImportPlan.trigger.kind event) takes only { "cadence": "manual" }: it has no timetable.

Show child attributes

name

string

The import's name when absent.

Required string length: 1 - 120

timezone

string

The timezone its schedule runs in (IANA name); the store's when absent.

Required string length: 1 - 64

bindings

object

Steps bound to your connections at set-up. A step left unbound keeps the automation off, as a draft.

Show child attributes

Response

Created. State is active unless schedule.cadence is manual (a workflow that starts on a store event takes only that, and is active) or a step still needs a connection, then draft. Carries readiness.

success

boolean

required

contract_version

integer

required

The version of the API this answer follows. It changes only for a breaking change.

Required range: x >= 1

data

object

required

Show child attributes

Choose your outcome

Get Started

The AI OS

Create automation from import

Authorizations

Path Parameters

Body

Response