Start a flow on this conversation, live

POST 
/api/conversations/:conversationId/flows

Runs the flow on this conversation with the real sink: the customer receives the messages. This is not the canvas's dry run.

Refused, with a named reason, when the flow does not exist, does not declare an active manual trigger, has never been published, or when the conversation is already inside a flow. The four are separate messages on purpose — the agent has usually just told the customer something is coming, and one of those means wait while another means go and publish the flow.

Request

Responses

201

The flow started; its first step has already run.

401

Not authenticated. code: account_disabled means the member's seat was deactivated in this workspace: the session is over even though the token was not revoked (clients sign out and clean up).

403

Authenticated but not allowed.

404

Resource not found (or not visible to the current tenant).

422

The request failed validation.