Cancel a queued workflow item

POST

client

workflows

{workflow_id}

queue

{queue_id}

cancel

Cancel a queued workflow item

curl --request POST \
  --url http://localhost:8080/api/v1/client/workflows/{workflow_id}/queue/{queue_id}/cancel \
  --header 'Authorization: <api-key>'

{
  "data": {
    "contact_id": 123,
    "execution_id": 123,
    "is_test": true,
    "processed_at": "<string>",
    "queue_id": 123,
    "reason": "<string>",
    "status_text": "<string>",
    "workflow_id": 123
  },
  "errors": [
    {
      "condition": "format",
      "error": "Invalid email format",
      "key": "email"
    }
  ],
  "message": "Operation successful",
  "meta": {},
  "success": true
}

Authorizations

Authorization

string

header

required

JWT Bearer token or raw API key via Authorization header

Path Parameters

workflow_id

integer

required

Workflow ID

queue_id

integer

required

Queue ID

Response

data

object

Show child attributes

errors

object[]

Show child attributes

message

string

Example:

"Operation successful"

meta

object

success

boolean

Example:

true

List client workflowsRetrieve workflows available to the authenticated client, including enrollment status, trigger tags, and template references.

⌘I

Cancel a queued workflow item

curl --request POST \
  --url http://localhost:8080/api/v1/client/workflows/{workflow_id}/queue/{queue_id}/cancel \
  --header 'Authorization: <api-key>'

{
  "data": {
    "contact_id": 123,
    "execution_id": 123,
    "is_test": true,
    "processed_at": "<string>",
    "queue_id": 123,
    "reason": "<string>",
    "status_text": "<string>",
    "workflow_id": 123
  },
  "errors": [
    {
      "condition": "format",
      "error": "Invalid email format",
      "key": "email"
    }
  ],
  "message": "Operation successful",
  "meta": {},
  "success": true
}