v4

latestSwagger 2.02026-07-1333110154.1 KB

Submits request to cancel an existing job by Id while supplying free-form cancellation reason.

Submits request to cancel an existing job by Id while supplying free-form cancellation reason.

post/routing/jobs/{jobId}:cancel

Path parameters

jobIdstring required

Id of a job.

Query parameters

api-versionstring required

The API version to use for this operation.

Request body

notestring

A note that will be appended to a job's Notes collection with the current timestamp.

dispositionCodestring

Indicates the outcome of a job, populate this field with your own custom values. If not provided, default value of "Cancelled" is set.

Response

The request has succeeded.

CancelJobResult required

Response payload from cancelling a job.