Jobs

Cancel job

Cancels a queued or running job. Already-terminal jobs return 409.

post/jobs/{id}/cancel

Request

  • Base URL: https://app.buildworkpro.com/api/v1
  • URL: https://app.buildworkpro.com/api/v1/jobs/{id}/cancel
  • Auth: HTTP bearer

Path parameters

idstring required

Headers

Idempotency-Keystring uuid

Idempotent retry key for mutating operations. The first request with a given key executes normally and BuildWorkPro caches the response. Replaying the same key with the same request body (method + path + JSON body, SHA-256 hashed) returns the cached response without re-executing the mutation. Replaying with a DIFFERENT body returns 409 idempotency_key_reused. The cache TTL is 24 hours; after expiry the key is treated as a new operation. Keys are tenant-scoped. Recommended: a fresh UUID v4 per logical operation.

Response

Cancelled

Changes

No recorded changes to this operation across all 1 revision of this API.