Skip to main content
POST
Move a coming run

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
slot_at
string<date-time>
required

A time in UTC (ISO 8601).

run_at
string<date-time>
required

A time in UTC (ISO 8601).

scope
enum<string>
required
Available options:
this,
this_and_later
occurrence_version
integer
required

The coming run's version you last read; 0 for a projected one.

Required range: x >= 0
automation_version
integer
required
Required range: x >= 1

Response

The coming run after the change, and the automation as it now is.

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