Skip to content

cancelJob

Deprecated

This endpoint will stop working on 1 August 2027. Migrate to POST /v1/jobs/{id}/cancel in the new API; the migration guide has the recommended order of work and the important model differences.

Open POST /v1/jobs/{id}/cancel in the new API →

View legacy reference
/rest/workflow/job/cancelJob


POST
Cancels a job.

Changes from previous version

  • Add cancelled date which will be used to record against the Job Event.  If blank use current date time.  API must still work if date field not provided.

acceptable request representations:

  • application/json

{  "clientId":"1",  "clientRef":"CLIREF01",  "jobRef":"J00123",
  "message":"some message",  "cancellationType":"1",  "reasonId":"1",  "date":"12/12/2012"}


available response representations:
  • 200 - application/json
{
  "result" : "success or fail",
  "result_msg" : "error message"
}

Notes

  • Cancellation Type: 0 = Not Selected, 1 = Cancel, 2 = Abort
  • Reason ID: 1 = General,2 = Marketing,3 = CONFIDENTIAL,4 = Attempted Contact,5 = Recall Requested,6 = Tenant Survey Returned. Results:,7 = Description of Works Carried Out ,8 = Chase Up,9 = Variation Agreed by Client,10 = Email Received,11 = Self Cert Variation,12 = Email sent to Client,13 = Collecting Materials,14 = Tenant Not In,15 = Travel Problems,16 = Van Change,17 = Called to an Emergency,18 = Held up at Earlier Appointment,19 = Default,20 = Two People Required,21 = Additional Works Needed,22 = Materials Required,23 = Carded - Tenant Out,24 = At Tenant Request,25 = No Resources Available,26 = Materials On Order,27 = At Tenant Request,28 = No Longer Required,29 = Raised in Error,30 = At Tenant Request,31 = No Longer Required,32 = Jobs cancelled due to Costs being transferred,33 = Raised in Error

See the Workflow API matrix for the full list of endpoints in this category.