Skip to content
X-Buddy
Tiếng Việt

API reference

Cancel job

job_cancel — Cancel a job.

Markdown version

job_cancel · Delete / cannot be undone

Cancel a job. Waiting or held jobs are cancelled for sure. A running job is asked to stop: it ends cancelled, or succeeded if X already did it, or unknown if it passed the point of no return.
REST POST /api/public/v1/jobs/{job_id}/cancel
MCP tool job_cancel
Permission needed accounts.run — Owner, Manager, Operator
Scope group x:engage
Group Core: X accounts, jobs, tool search
Shown up front in profiles every profile (core set)

Input

Field Type Required Description
job_id string (uuid) Yes Job to cancel.

Result

Returns the operation's result in the { data, meta } envelope.

Needs an idempotency key (Idempotency-Key, 8–128 characters). Retrying with the same key never repeats the action.

This deletes data or can't be undone. Ask the person before calling it.

Example

Call over REST

curl -X POST "https://reach-link-craft.lovable.app/api/public/v1/jobs/00000000-0000-4000-8000-000000000001/cancel" \
  -H "Authorization: Bearer $XBUDDY_API_KEY" \
  -H "Idempotency-Key: 6f1c2a90-example-key" \
  -H "Content-Type: application/json" \
  -d '{}'

Call over MCP

{
  "method": "tools/call",
  "params": {
    "name": "job_cancel",
    "arguments": {
      "job_id": "00000000-0000-4000-8000-000000000001",
      "idempotency_key": "6f1c2a90-example-key"
    }
  }
}

Errors you may get

Code HTTP Retryable
unauthorized 401 No
key_expired 401 No
integration_revoked 401 No
connection_not_linked 403 No
integration_paused 403 No
workspace_integrations_paused 403 No
integration_authorization_lost 403 No
workspace_suspended 403 No
forbidden 403 No
invalid_input 422 No
rate_limited 429 Yes
internal 500 Yes
read_only 403 No
idempotency_key_required 428 No
idempotency_conflict 409 No
idempotency_processing 409 Yes
conflict 409 No
precondition_failed 422 No
not_found 404 No

Back to all operations