API Reference

Cancel workflow run

post
https://api.joinpopp.com/v1/workflow-runs//cancel

Cancels an in-flight workflow run. By default any active conversation is left to complete naturally; pass closeActiveConversations: true in the body to close it as part of the cancellation.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Identifier of the workflow run (from the start/list endpoints). Older runs may return a composite id containing reserved characters (e.g. #); URL-encode these in the path (# becomes %23).

Body Params

Optional cancellation metadata.

Input for cancelling an in-flight workflow run. Body is optional.

string

Optional human-readable reason for the cancellation. Stored on the run for audit purposes.

boolean

When true, any conversation currently in progress for this run is closed as part of the cancellation. Defaults to false (the conversation is left to complete naturally).

Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?