Skip to main content
POST
/
v3
/
background-jobs
/
{jobId}
/
cancel
Cancel a background job
curl --request POST \
  --url https://api.reply.io/v3/background-jobs/{jobId}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "<string>"
}
'
{
  "title": "Bad Request",
  "status": 400,
  "detail": "Job id must be a non-empty GUID.",
  "code": "backgroundJob.invalidJobId"
}

Authorizations

​
Authorization
string
header
required

Authenticate every request with a Bearer token. Pass your Reply API key in the Authorization header:

Authorization: Bearer <your-api-key>

Get your API key from the Reply dashboard: Settings → API Key.

Path Parameters

​
jobId
string<uuid>
required

Background job identifier (must be a non-empty GUID)

Body

application/json

Optional payload for cancelling a background job. The body itself is optional — POST with an empty body is valid.

​
reason
string | null

Optional human-readable reason for the cancellation, recorded with the job

Response

Cancellation requested successfully (or already cancelled — idempotent)