Skip to main content
POST
Run now

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
idempotency_key
string
required

A key you make, at least 8 characters, new for each run you mean, and one across all your organisation's automations: the same key returns the same run, and one already used for another automation is refused.

Required string length: 8 - 64
mode
enum<string>
required

normal, or test: reads are real and every change to your store is refused.

Available options:
normal,
test

Response

Accepted. The run is queued; follow it with Get run.

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