SymDocs
Workspace API
All productsSym Workspace APISym Passes MCP
Supportjoinsym.com ↗
Sym Workspace API

Cancel an operation

Request cancellation without deleting durable history.

API 2.7.0 · Published service contract ↗

Request

Base URL: https://app.sym.so/v1/workspaces/{workspace_id}

Authentication: bearer. Required scope: operations:cancel.

POST /operations/{operation_id}/cancel

Request cancellation without deleting durable history.

ParameterTypeDescription
operation_id
path · required
stringRequired operation_id path identifier.
Request
curl --fail-with-body -X POST "https://app.sym.so/v1/workspaces/$WORKSPACE_ID/operations/$OPERATION_ID/cancel" \
  -H "Authorization: Bearer $SYM_WORKSPACE_API_KEY"
Response 200
{
  "worker_id": "worker-example-001",
  "org_id": "workspace_example",
  "item": {
    "id": "op_01J8",
    "status": "cancelled",
    "cancel_requested_at": "2026-08-05T08:31:00Z",
    "completed_at": "2026-08-05T08:31:00Z"
  },
  "ok": true
}

Authorization

Credential contract
{
  "type": "bearer",
  "scope": "operations:cancel",
  "transport": "Authorization: Bearer <workspace_api_key>"
}

Errors

StatusDescription
400The request body or parameters are invalid.
401The workspace API key is missing, invalid, expired, or revoked.
403The key lacks the required scope or its owner no longer has permission.
404The resource is missing or intentionally hidden by authorization.
429The key exceeded its current rate limit.