Create automation

curl --request POST \
  --url https://automations-api.vortexiq.ai/v1/automations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "template_id": "shopify-catalogue-quality",
  "integration_id": 101,
  "name": "Weekly catalogue check",
  "inputs": {},
  "schedule": {
    "cadence": "manual"
  }
}
'

import requests

url = "https://automations-api.vortexiq.ai/v1/automations"

payload = {
    "template_id": "shopify-catalogue-quality",
    "integration_id": 101,
    "name": "Weekly catalogue check",
    "inputs": {},
    "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({
    template_id: 'shopify-catalogue-quality',
    integration_id: 101,
    name: 'Weekly catalogue check',
    inputs: {},
    schedule: {cadence: 'manual'}
  })
};

fetch('https://automations-api.vortexiq.ai/v1/automations', 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",
  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([
    'template_id' => 'shopify-catalogue-quality',
    'integration_id' => 101,
    'name' => 'Weekly catalogue check',
    'inputs' => [
        
    ],
    '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"

	payload := strings.NewReader("{\n  \"template_id\": \"shopify-catalogue-quality\",\n  \"integration_id\": 101,\n  \"name\": \"Weekly catalogue check\",\n  \"inputs\": {},\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")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"template_id\": \"shopify-catalogue-quality\",\n  \"integration_id\": 101,\n  \"name\": \"Weekly catalogue check\",\n  \"inputs\": {},\n  \"schedule\": {\n    \"cadence\": \"manual\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://automations-api.vortexiq.ai/v1/automations")

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  \"template_id\": \"shopify-catalogue-quality\",\n  \"integration_id\": 101,\n  \"name\": \"Weekly catalogue check\",\n  \"inputs\": {},\n  \"schedule\": {\n    \"cadence\": \"manual\"\n  }\n}"

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

{
  "success": true,
  "contract_version": 1,
  "data": {
    "automation": {
      "id": "01M520GSDQH5TQ3CAAQ584TTKH",
      "version": 1,
      "kind": "template",
      "import_id": null,
      "template_id": "shopify-catalogue-quality",
      "template_version": 4,
      "platform": "shopify",
      "integration_id": 101,
      "store_label": "Example Shopify store",
      "name": "Weekly catalogue check",
      "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": 2,
      "next_run_at": null,
      "last_run_at": null,
      "consecutive_failures": 0,
      "send_mode": "ask",
      "created_at": "2026-10-16T09:26:03.448Z",
      "updated_at": "2026-10-16T09:26:03.448Z",
      "created_by": 7,
      "created_via": "api-token",
      "api_client_id": "viq_auto_Ab12Cd34Ef56Gh78Ij90Kl12"
    }
  }
}

{
  "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

Set up an automation from a template on one of your stores, with the template’s inputs and a schedule.

With a schedule (daily, weekly and the other cadences), the automation is active and its runs are queued at the times the schedule gives, in the store’s timezone unless you send timezone.
With schedule.cadence: manual, it is a draft that runs only when you run it now.
A template that starts when the store sends an event (it has a trigger) takes only schedule.cadence: manual, and its automation is active at once.

The automation is set up even when the template is not ready yet (its readiness says why, such as a connection your organisation does not have). Its runs then end refused (connection_missing), saying what to connect, until that connection is there.

The automation is recorded as created by the person you logged in as, through the API (created_via: api-token, with your api_client_id). Answers 404 when the template or the store is not your organisation’s, and 422 when the store is not connected, or an input or the schedule is not valid.

Needs the automations:write scope.

POST

automations

Create automation

curl --request POST \
  --url https://automations-api.vortexiq.ai/v1/automations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "template_id": "shopify-catalogue-quality",
  "integration_id": 101,
  "name": "Weekly catalogue check",
  "inputs": {},
  "schedule": {
    "cadence": "manual"
  }
}
'

import requests

url = "https://automations-api.vortexiq.ai/v1/automations"

payload = {
    "template_id": "shopify-catalogue-quality",
    "integration_id": 101,
    "name": "Weekly catalogue check",
    "inputs": {},
    "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({
    template_id: 'shopify-catalogue-quality',
    integration_id: 101,
    name: 'Weekly catalogue check',
    inputs: {},
    schedule: {cadence: 'manual'}
  })
};

fetch('https://automations-api.vortexiq.ai/v1/automations', 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",
  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([
    'template_id' => 'shopify-catalogue-quality',
    'integration_id' => 101,
    'name' => 'Weekly catalogue check',
    'inputs' => [
        
    ],
    '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"

	payload := strings.NewReader("{\n  \"template_id\": \"shopify-catalogue-quality\",\n  \"integration_id\": 101,\n  \"name\": \"Weekly catalogue check\",\n  \"inputs\": {},\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")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"template_id\": \"shopify-catalogue-quality\",\n  \"integration_id\": 101,\n  \"name\": \"Weekly catalogue check\",\n  \"inputs\": {},\n  \"schedule\": {\n    \"cadence\": \"manual\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://automations-api.vortexiq.ai/v1/automations")

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  \"template_id\": \"shopify-catalogue-quality\",\n  \"integration_id\": 101,\n  \"name\": \"Weekly catalogue check\",\n  \"inputs\": {},\n  \"schedule\": {\n    \"cadence\": \"manual\"\n  }\n}"

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

{
  "success": true,
  "contract_version": 1,
  "data": {
    "automation": {
      "id": "01M520GSDQH5TQ3CAAQ584TTKH",
      "version": 1,
      "kind": "template",
      "import_id": null,
      "template_id": "shopify-catalogue-quality",
      "template_version": 4,
      "platform": "shopify",
      "integration_id": 101,
      "store_label": "Example Shopify store",
      "name": "Weekly catalogue check",
      "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": 2,
      "next_run_at": null,
      "last_run_at": null,
      "consecutive_failures": 0,
      "send_mode": "ask",
      "created_at": "2026-10-16T09:26:03.448Z",
      "updated_at": "2026-10-16T09:26:03.448Z",
      "created_by": 7,
      "created_via": "api-token",
      "api_client_id": "viq_auto_Ab12Cd34Ef56Gh78Ij90Kl12"
    }
  }
}

{
  "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.

Body

application/json

template_id

string

required

The template's id, such as shopify-catalogue-quality.

Pattern: ^[a-z0-9][a-z0-9-]{1,80}$

name

string

required

Required string length: 1 - 120

inputs

object

required

schedule

object

required

Show child attributes

integration_id

integer

The store or account it runs on. Required unless its template runs on nothing, and refused when it does.

connections

integer[]

For a template that runs on nothing, the connections it reads, by id, in the order to read them: each the organisation's own, connected, and of a kind in the template's connections. Refused for any other template.

Required array length: 1 - 20 elements

Required range: x >= 1

timezone

string

The timezone its schedule runs in (IANA name, such as Europe/London); the store's when absent.

Required string length: 1 - 64

Response

Created. The automation, with its first run time when it has a schedule.

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

Authorizations

Body

Response