BIbigchange
Jobs

Cancel a job

Cancels a specific job. The job cannot be cancelled if it has already been started, suspended or completed (required scope jobs:write)

put/v1/jobs/{jobId}/cancel

Request

  • Base URL
    https://api.bigchange.com
  • URL
    https://api.bigchange.com/v1/jobs/{jobId}/cancel
  • Auth
    HTTP bearer

Path parameters

jobIdinteger required

Headers

Customer-Idinteger required

The customer identifier

Request body

reasonstring nullable

A textual reason as to why the job is cancelled

Example request

{
  "reason": "Customer no longer requires the work"
}

Response

No Content

Changes

No recorded changes to this operation across all 13 revisions of this API.