Background Jobs
Cancel a background job
<small>Requires the other:operate scope (or a broader one that includes it).</small>
Requests cancellation of a background job. Idempotent — cancelling an already-terminal job returns 204 without effect on the worker. The request body is optional; if provided, the reason is recorded alongside the cancellation event.
post/v3/background-jobs/{jobId}/cancel
Request
- Base URLhttps://api.reply.io
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
jobIdstring uuid required
Background job identifier (must be a non-empty GUID)
Request body
Response
Cancellation requested successfully (or already cancelled — idempotent)
Changes
No recorded changes to this operation across all 1 revision of this API.