Skip to main content
POST
Preview workflow change

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 automation's version the workflow was read at.

Required range: x >= 1
workflow
object
required

Response

The differences, and the preview_hash to save them with.

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