Cancel booking

Cancel or withdraw a booking

POST/v1/bookings/{bookingId}/cancel

curl -X POST 'https://www.yovamos.com/v1/bookings/bkg_bk000001/cancel' \
  -H 'x-manage-token: mu8_4y8WOdIm_zK99LM3BBwWq8RdowYV' \
  -H 'Content-Type: application/json' \
  -d '{}'

{
  "id": "bkg_bk000001",
  "status": "canceled",
  "business": {
    "id": "biz_1v8g0yh11jl8ti",
    "name": "The Spot Barbershop",
    "timezone": "America/Los_Angeles"
  },
  "service": {
    "id": "svc_1wwvyo2007ynbx",
    "name": "Haircut"
  },
  "staff": {
    "id": "stf_0ngvtdm17z44qf",
    "name": "Marcus"
  },
  "startsAt": "2027-01-12T17:00:00Z",
  "endsAt": "2027-01-12T17:45:00Z",
  "local": "Tue, Jan 12 · 9:00–9:45 AM PST",
  "durationMinutes": 45,
  "partySize": 1,
  "price": {
    "amountMinor": 3500,
    "currency": "USD",
    "display": "$35.00"
  },
  "customer": {
    "name": "Sam Rivera",
    "email": "sam@example.com"
  },
  "source": "Dots",
  "consent": {
    "statement": "Yes, book it.",
    "at": "2027-01-11T21:40:12.000Z"
  },
  "manageUrl": "https://www.yovamos.com/booking/manage?booking=bkg_bk000001",
  "createdAt": "2027-01-11T21:40:12.000Z",
  "next": [
    "Tell the customer the booking is canceled and offer to find another time."
  ],
  "untrusted": [
    "business.name",
    "service.name",
    "staff.name",
    "customer.name",
    "consent.statement"
  ],
  "cancellation": {
    "by": "customer",
    "canceledAt": "2027-01-11T22:05:00.000Z"
  }
}

Headers

x-manage-tokenstringRequired
The manageToken returned by create_booking. Proves the caller is the customer. Never show it to anyone else.

Path parameters

bookingIdstringRequired
Booking id as returned by create_booking (prefix bkg_).

Body

reasonstring (up to 280 characters)
Why the customer is canceling. Optional.

Responses

200
A booking: its status, time, price, the customer's consent record and what to do next.
Booking
404
No such id, or it is not visible to this key.
NotFound
409
The booking is not in a state that allows this.
InvalidState

Search documentation

Businesses

Services

Staff

Resources

Slots

Quotes

Bookings

ScheduleOperator key

System

Guidance for apps and assistants

Headers

Path parameters

Body

Responses