Cancel Job

post

https://api.sandbox.serverobotics.com/v2/partners/{partner_id}/jobs/{job_id}/cancel

Cancel an ongoing job. A job can be canceled prior to a courier completing the dropoff.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

partner_id

string

required

length ≥ 1

Partner ID

job_id

string

required

length ≥ 1

Job ID

Body Params

Cancel job request

Request for cancelling a job

reason

string

enum

required

Defaults to other_reason

Partner-supplied reason for cancellation.

notes

string

Optional notes about the cancellation.

bypass_partner_errors

boolean | null

Force FSM progression bypassing partner error checks.

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Canceled job