Cancel Pickup

Use this endpoint to cancel a scheduled pickup.

REST Endpoint

POST /restapi/v1/customers/:customerId/pickups/:pickupId

Request Content Type

application/json

Request JSON Example

{
  "cancelled": true
}

Explanation of Request Fields

Field Type Required Description
cancelled boolean true Must be true

Response Status Code

201 Created

Response Content Type

application/json

Response JSON Example

{
  "ok": true
}