v4

latestSwagger 2.02026-07-1333110154.1 KB

Closes a completed job.

post/routing/jobs/{jobId}/assignments/{assignmentId}:close

Path parameters

jobIdstring required

Id of a job.

assignmentIdstring required

Id of a job assignment.

Query parameters

api-versionstring required

The API version to use for this operation.

Request body

dispositionCodestring

Indicates the outcome of a job, populate this field with your own custom values.

closeAtstring date-time

If not provided, worker capacity is released immediately along with a JobClosedEvent notification. If provided, worker capacity is released along with a JobClosedEvent notification at a future time in UTC.

notestring

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

Response

The request has succeeded.

CloseJobResult required

Response payload from closing a job.