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.

Path Parameters

template
string
required

The template's key, such as send-approved-purchase-orders.

Body

application/json

A starter template to create an automation from, with its blanks filled in.

name
string | null

The new automation's name, up to 120 characters. The template's name is used when it is left out.

Maximum string length: 120
description
string | null

The new automation's description, up to 2000 characters. The template's description is used when it is left out.

Maximum string length: 2000
blanks
object

The value for each of the template's blanks, by the blank's key, such as {"team": "Receiving"}: a role's name, a member's ID, a number, a URL or a location's ID.

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.