Cancel scheduled booking

Cancel a confirmed booking

POST/v1/operator/schedule/{bookingId}/cancel

curl -X POST 'https://www.yovamos.com/v1/operator/schedule/bkg_bk000001/cancel' \
  -H "Authorization: Bearer $VAMOS_OPERATOR_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "reason": "We are closed that day, sorry."
}'

{
  "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": [
    "This booking was canceled. Nothing to decide."
  ],
  "untrusted": [
    "business.name",
    "service.name",
    "staff.name",
    "customer.name",
    "consent.statement",
    "cancellation.reason"
  ],
  "cancellation": {
    "by": "business",
    "reason": "We are closed that day, sorry.",
    "canceledAt": "2027-01-11T22:05:00.000Z"
  }
}

Headers

AuthorizationBearer tokenRequired
Your operator key. Authentication

Path parameters

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

Body

reasonstring (up to 280 characters)
Why it is canceled, in words the customer will read.

Responses

200
A booking: its status, time, price, the customer's consent record and what to do next.
Booking
403
The key is valid but may not do this.
Forbidden
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