Cancels a maintenance job

Scope: write:maintenance

Does what cancelling a job in Loop does: the job becomes cancelled, with the date, the
reason and the cancelling agent in cancellation, and Loop's "Cancelled job … by …" note is
written. Its quotes are left as they are. Only a notAcknowledged, pending or approved
job can be cancelled, as in Loop; any other answers 409.

reason is required, up to 320 characters. userId is recorded as the cancelling agent,
must be in the job's team and defaults to its first agent. No emails are sent to the
contractor, landlord or tenant.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

Maintenance job id

Body Params

Why, and who cancelled it

Cancel a job (ENG-7139).

string
required
length between 0 and 320

Why the job is cancelled. Shown on the job in Loop.

uuid | null

Recorded as the cancelling agent. Must be in the job's team; default its first agent.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

403

The API key doesn't have the scope this endpoint needs.

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json
*/*