Skip to main content
POST
Preview (and optionally commit) an action

Authorizations

Authorization
string
header
required

API token issued from the Equated app under Settings → API Tokens.

Body

application/json
kind
enum<string>
required
Available options:
attach_evidence
transactionId
integer
required
Required range: x > 0
documentId
integer
required
Required range: x > 0
commit
boolean

Response

200 - application/json

Preview payload (read-only) or persisted action request

touchedRecords
null[]
required
id
string<uuid>

Saved action request ID when commit=true; pass to execute_action.

previewPayload
unknown
status
string
expiresAt
string<date-time>