Cancel a booking
/bookings/{booking_id}/cancelCancels a confirmed booking and its linked visit, frees the slot and fires booking.cancelled (and
visit.cancelled for in-person bookings). With notify_attendee (the default), Agoo tells the attendee.
Any other status returns invalid_state: to turn down a pending booking, decline it with
POST /bookings/{booking_id}/decline.
Scope: bookings:write · Plan: Pro and Enterprise in live mode; every plan in test mode.
Send Authorization: Bearer <token> on every request. The token is one of:
| Prefix | What it is | Where it may be used |
|---|---|---|
agoo_sk_live_ | Secret key, live mode | Your servers only |
agoo_sk_test_ | Secret key, test mode | Your servers only |
agoo_pk_live_ | Publishable key, live mode | Browsers and apps: create pre-registrations and bookings, read public booking types (with their intake questions) and their free slots, read the visit types open for pre-registration with their public forms. Never lists people. |
agoo_pk_test_ | Publishable key, test mode | As above, in test mode |
Admins create keys in Console → Developers → API keys and choose each key's scopes. A key is shown once. Never put a secret key in a URL, a browser or a mobile app.
In: header
Scope: bookings:write
Path Parameters
The booking's ID.
^booking_[0-7][0-9a-hjkmnp-tv-z]{25}$"booking_01m4dtqd00eq4rtc1jdsr1gr6z"Header Parameters
A UUID you generate for this operation. If you retry with the same key within 24 hours, Agoo returns the
original response instead of acting twice. While the first request is still running, a retry returns
conflict. Reusing a key with a different request returns idempotency_key_reused. Responses with
rate_limited, internal_error or unavailable aren't stored, so retry those with the same key.
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/bookings/booking_01m4dtqd00eq4rtc1jdsr1gr6z/cancel" \ -H "Idempotency-Key: 3f6b2a1e-8c4d-4f7a-9b2e-5d1c0a7e9f64" \ -H "Content-Type: application/json" \ -d '{ "reason": "Kwame is travelling that day.", "notify_attendee": true }'{ "id": "booking_01m4dtqd00eq4rtc1jdsr1gr6z", "status": "cancelled", "booking_type_id": "btype_01kn44arm0eya81713cpbnfbpq", "host_id": "person_01kjsesxm0e4zbyvkr7bcfxbfg", "start_at": "2026-10-16T14:30:00Z", "end_at": "2026-10-16T15:00:00Z", "time_zone": "Africa/Accra", "meeting_kind": "in_person", "site_id": "site_01kjpt3yw0fz0v414608h9x65s", "meeting_url": null, "address": null, "attendee": { "name": "Ama Owusu", "phone": "+233241234567", "email": "ama@coastline.example", "company": "Coastline Consult" }, "visit_id": "visit_01m4dtqdz8f59rarmdksqjprz9", "custom_fields": {}, "confirm_by": null, "confirmed_at": "2026-10-08T13:20:00Z", "declined_at": null, "decline_reason": null, "cancelled_at": "2026-10-12T17:02:00Z", "cancellation_reason": "Kwame is travelling that day.", "created_at": "2026-10-08T13:20:00Z", "updated_at": "2026-10-12T17:02:00Z"}Reschedule a booking POST
Moves a `confirmed` booking to another free slot. Agoo tells the attendee and the host, moves the linked visit and fires `booking.rescheduled` (and `visit.updated` for in-person bookings). Returns `conflict` if the new slot isn't free and `invalid_state` if the booking isn't `confirmed`. A `pending` booking can't be moved; confirm or decline it first. **Scope:** `bookings:write` · **Plan:** Pro and Enterprise in live mode; every plan in test mode.
Confirm a booking POST
Confirms a `pending` booking, for booking types that require host confirmation. Agoo tells the attendee it's confirmed, schedules their reminders and fires `booking.confirmed`. For an `in_person` booking it also creates the expected visit with a QR pass, so `visit.created` and `pass.sent` fire too. Returns `invalid_state` if the booking isn't `pending`, for example because it expired or the attendee cancelled it. **Scope:** `bookings:write` · **Plan:** Pro and Enterprise in live mode; every plan in test mode.