post https://api.talkdeskapp.com/flows//interactions
Starts an interaction that executes the published version of the flow
Scope
flows-interactions:start
Body Request - Example
{
"order_id": "34e1686578e222048f4rhe06dcdf517a84"
}
Body Response - Schema
202 (flow interaction started result)
| Parameter | Type | Description | Required |
|---|---|---|---|
| interaction_id | string | the identifier of the interaction that started based on the provided flow | yes |
| flow_version_id | string | The identifier of the flow version of the interaction that started | yes |
| flow_execution_id | string | The ID of the Flow Execution that was started. | yes |
400 (invalid JSON), 401 (unauthorized), 403 (forbidden), 404 (flow not found), 413 (request too large)
| Parameter | Description | Type | Required |
|---|---|---|---|
| code | string | n/a | yes |
| message | string | n/a | yes |
| description | string | n/a | no |
| fields | array[object] | "fields" subdivides into: "name" (string) "description" (string) | yes (name and description) |
Troubleshooting
If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.