Execute Publish Flow

Starts an interaction that executes the published version of the flow

📘

Supported Regions and Base URLs

Scope

flows-interactions:start

Request Body

{
  "order_id": "34e1686578e222048f4rhe06dcdf517a84"
}

Body Response - Schema

202 (flow interaction started result)

ParameterTypeDescriptionRequired
interaction_idstringthe identifier of the interaction that started based on the provided flowyes
flow_version_idstringThe identifier of the flow version of the interaction that startedyes

400 (invalid JSON), 401 (unauthorized), 403 (forbidden), 404 (flow not found), 413 (request too large), 415 (unsupported media type)

ParameterDescriptionTypeRequired
codestringn/ayes
messagestringn/ayes
descriptionstringn/ano
fieldsarray[object]"fields" subdivides into:

"name" (string)

"description" (string)
yes (name and description)
Language
Authentication
OAuth2
URL
Click Try It! to start a request and see the response here!