Skip to main content
POST
Cancel a background job

Authorizations

Authorization
string
header
required

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

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)