Update automation

curl --request PATCH \
  --url https://automations-api.vortexiq.ai/v1/automations/{automationId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "version": 1,
  "schedule": {
    "cadence": "weekly",
    "day_of_week": 1,
    "run_at": "07:00"
  }
}
'

import requests

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

payload = {
    "version": 1,
    "schedule": {
        "cadence": "weekly",
        "day_of_week": 1,
        "run_at": "07:00"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({version: 1, schedule: {cadence: 'weekly', day_of_week: 1, run_at: '07:00'}})
};

fetch('https://automations-api.vortexiq.ai/v1/automations/{automationId}', 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/{automationId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'version' => 1,
    'schedule' => [
        'cadence' => 'weekly',
        'day_of_week' => 1,
        'run_at' => '07:00'
    ]
  ]),
  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/{automationId}"

	payload := strings.NewReader("{\n  \"version\": 1,\n  \"schedule\": {\n    \"cadence\": \"weekly\",\n    \"day_of_week\": 1,\n    \"run_at\": \"07:00\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://automations-api.vortexiq.ai/v1/automations/{automationId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"version\": 1,\n  \"schedule\": {\n    \"cadence\": \"weekly\",\n    \"day_of_week\": 1,\n    \"run_at\": \"07:00\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"version\": 1,\n  \"schedule\": {\n    \"cadence\": \"weekly\",\n    \"day_of_week\": 1,\n    \"run_at\": \"07:00\"\n  }\n}"

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

{
  "success": true,
  "contract_version": 1,
  "data": {
    "automation": {
      "id": "01M520GSDQH5TQ3CAAQ584TTKH",
      "version": 2,
      "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": "active",
      "trigger": {
        "kind": "schedule"
      },
      "paused_by": null,
      "paused_reason": null,
      "inputs": {},
      "bindings": {},
      "plan_version": 1,
      "connections": [],
      "schedule": {
        "cadence": "weekly",
        "run_at": "07:00",
        "day_of_week": 1,
        "day_of_month": null,
        "date": null,
        "days": null,
        "week_of_month": null
      },
      "timezone": "Europe/London",
      "spread_minutes": 2,
      "next_run_at": "2026-10-19T06:02:00.000Z",
      "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.517Z",
      "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,
  "code": "stale_version",
  "message": "<string>",
  "data": {
    "automation": {
      "id": "<string>",
      "kind": "template",
      "import_id": "<string>",
      "version": 2,
      "template_id": "<string>",
      "template_version": 2,
      "platform": "shopify",
      "integration_id": 123,
      "store_label": "<string>",
      "name": "<string>",
      "state": "draft",
      "paused_by": "merchant",
      "paused_reason": "<string>",
      "inputs": {},
      "schedule": {
        "cadence": "manual",
        "run_at": "<string>",
        "day_of_week": 4,
        "day_of_month": 16,
        "date": "<string>",
        "days": [
          4
        ],
        "week_of_month": 1
      },
      "timezone": "<string>",
      "spread_minutes": 4,
      "next_run_at": "2023-11-07T05:31:56Z",
      "last_run_at": "2023-11-07T05:31:56Z",
      "consecutive_failures": 1,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "source": "n8n",
      "bindings": {},
      "plan_version": 2,
      "readiness": {
        "ready": true,
        "missing": [
          "klaviyo"
        ],
        "unconfigured": [
          {
            "step": "<string>",
            "kind": "store",
            "target": {
              "spreadsheet_id": "<string>",
              "sheet": "<string>"
            },
            "why": "no_connection"
          }
        ]
      },
      "connections": [
        {
          "integration_id": 2,
          "kind": "klaviyo"
        }
      ],
      "send_mode": "ask",
      "send_mode_allowed": true,
      "trigger": {
        "kind": "schedule"
      },
      "created_by": 123,
      "created_via": "ui",
      "api_client_id": "<string>"
    }
  }
}

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

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

Update automation

Change an automation’s name, inputs, schedule or timezone. Send only what changes, with the version you last read: if the automation has changed since, the answer is 409 stale_version with the current automation, so read it again and retry. Its coming runs are worked out again from a new schedule or timezone.

Giving a draft a schedule turns it on. For an imported workflow, workflow with the preview_hash from Preview workflow change replaces its steps.

Needs the automations:write scope.

PATCH

automations

{automationId}

Update automation

curl --request PATCH \
  --url https://automations-api.vortexiq.ai/v1/automations/{automationId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "version": 1,
  "schedule": {
    "cadence": "weekly",
    "day_of_week": 1,
    "run_at": "07:00"
  }
}
'

import requests

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

payload = {
    "version": 1,
    "schedule": {
        "cadence": "weekly",
        "day_of_week": 1,
        "run_at": "07:00"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({version: 1, schedule: {cadence: 'weekly', day_of_week: 1, run_at: '07:00'}})
};

fetch('https://automations-api.vortexiq.ai/v1/automations/{automationId}', 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/{automationId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'version' => 1,
    'schedule' => [
        'cadence' => 'weekly',
        'day_of_week' => 1,
        'run_at' => '07:00'
    ]
  ]),
  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/{automationId}"

	payload := strings.NewReader("{\n  \"version\": 1,\n  \"schedule\": {\n    \"cadence\": \"weekly\",\n    \"day_of_week\": 1,\n    \"run_at\": \"07:00\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://automations-api.vortexiq.ai/v1/automations/{automationId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"version\": 1,\n  \"schedule\": {\n    \"cadence\": \"weekly\",\n    \"day_of_week\": 1,\n    \"run_at\": \"07:00\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"version\": 1,\n  \"schedule\": {\n    \"cadence\": \"weekly\",\n    \"day_of_week\": 1,\n    \"run_at\": \"07:00\"\n  }\n}"

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

{
  "success": true,
  "contract_version": 1,
  "data": {
    "automation": {
      "id": "01M520GSDQH5TQ3CAAQ584TTKH",
      "version": 2,
      "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": "active",
      "trigger": {
        "kind": "schedule"
      },
      "paused_by": null,
      "paused_reason": null,
      "inputs": {},
      "bindings": {},
      "plan_version": 1,
      "connections": [],
      "schedule": {
        "cadence": "weekly",
        "run_at": "07:00",
        "day_of_week": 1,
        "day_of_month": null,
        "date": null,
        "days": null,
        "week_of_month": null
      },
      "timezone": "Europe/London",
      "spread_minutes": 2,
      "next_run_at": "2026-10-19T06:02:00.000Z",
      "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.517Z",
      "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,
  "code": "stale_version",
  "message": "<string>",
  "data": {
    "automation": {
      "id": "<string>",
      "kind": "template",
      "import_id": "<string>",
      "version": 2,
      "template_id": "<string>",
      "template_version": 2,
      "platform": "shopify",
      "integration_id": 123,
      "store_label": "<string>",
      "name": "<string>",
      "state": "draft",
      "paused_by": "merchant",
      "paused_reason": "<string>",
      "inputs": {},
      "schedule": {
        "cadence": "manual",
        "run_at": "<string>",
        "day_of_week": 4,
        "day_of_month": 16,
        "date": "<string>",
        "days": [
          4
        ],
        "week_of_month": 1
      },
      "timezone": "<string>",
      "spread_minutes": 4,
      "next_run_at": "2023-11-07T05:31:56Z",
      "last_run_at": "2023-11-07T05:31:56Z",
      "consecutive_failures": 1,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "source": "n8n",
      "bindings": {},
      "plan_version": 2,
      "readiness": {
        "ready": true,
        "missing": [
          "klaviyo"
        ],
        "unconfigured": [
          {
            "step": "<string>",
            "kind": "store",
            "target": {
              "spreadsheet_id": "<string>",
              "sheet": "<string>"
            },
            "why": "no_connection"
          }
        ]
      },
      "connections": [
        {
          "integration_id": 2,
          "kind": "klaviyo"
        }
      ],
      "send_mode": "ask",
      "send_mode_allowed": true,
      "trigger": {
        "kind": "schedule"
      },
      "created_by": 123,
      "created_via": "ui",
      "api_client_id": "<string>"
    }
  }
}

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

automationId

string

required

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

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

Body

application/json

version

integer

required

The version you last read.

Required range: x >= 1

name

string

Required string length: 1 - 120

inputs

object

schedule

object

Show child attributes

timezone

string

The timezone its schedule runs in (IANA name); its coming runs are worked out again.

Required string length: 1 - 64

bindings

object

A workflow automation's whole map of bound steps; a step left out is unbound. Each binding must be one of your organisation's connections, of the step's kind.

Show child attributes

connections

integer[]

The whole list of connections an automation of a template that runs on nothing reads, by id, checked as on set-up; refused for any other.

Required array length: 1 - 20 elements

Required range: x >= 1

send_mode

enum<string>

A workflow automation's sending, as Automation.send_mode. send is refused unless Automation.send_mode_allowed.

Available options:

ask,

send

workflow

object

A whole rewrite of a workflow automation's steps, saved as its next version. Sent with version and preview_hash only.

Show child attributes

preview_hash

string

The preview_hash from Preview workflow change. The change is saved only when it matches (preview_mismatch otherwise).

Pattern: ^[0-9a-f]{64}$

Response

The automation after the change.

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

Update automation

Authorizations

Path Parameters

Body

Response