Skip to main content
POST
Preview schema change

Authorizations

x-api-key
string
header
required

API key for authentication

Path Parameters

templateId
string<uuid>
required

Template ID

Body

application/json

Body

Request body for previewing a schema change without applying it

workflowId
string<uuid>
required

Linked workflow to preview

targetVersion
integer
required

Template version to preview

Required range: x >= 1

Response

200

Read-only AI-generated preview of how a schema change affects one linked workflow's data

error
enum<boolean>
required

Error flag (always false on success)

Available options:
false
data
object
required