Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.

Body

application/json

A new automation: its name and what it is for.

name
string
required

The automation's name, up to 120 characters, such as "Send approved purchase orders".

Maximum string length: 120
description
string | null

What the automation is for, up to 2000 characters. Leave it out or send null for none.

Maximum string length: 2000

Response

AutomationResource

data
AutomationResource · object
required

An automation with its draft, or the version it runs, the problems that keep that definition from being published, and its versions.