Bookings
Decline booking
Acts on behalf of the venue at a granted location.
Esta página aún no está disponible en tu idioma.
https://api.maple.inc/v1/bookings/{bookingId}/declineAPI keyActs on behalf of the venue at a granted location. Requires bookings:manage. Returns the full booking; stale versions answer 409 stale_version, illegal transitions 409 illegal_transition with details.from_status, and unsupported providers 422 capability_unsupported.
Authorization
Send your API key as Authorization: Bearer <key>: mpk_test_… against the sandbox (https://api.staging.maple.inc/v1), mpk_live_… against production. See Authentication. The samples read the key from MAPLE_KEY and the base URL from MAPLE_BASE, as set up in the Quickstart.
Parameters
bookingIdstring required
Request body
application/json, required.
-
expected_versioninteger or nullOptimistic concurrency: the
versionyou last read. A booking that moved on since answers 409stale_versionwithdetails.expected/actual.
Responses
200 OK
-
objectstring requiredAlways
booking. -
idstring requiredOpaque, prefixed
bkg_…. -
livemodeboolean required -
creatednumber required -
versionnumber required -
location_idstring required -
statusstring requiredOne of
requested,confirmed,seated,completed,declined_by_venue,cancelled_by_guest,cancelled_by_venue,cancelled_unattributed,no_show. -
service_statestring or null required -
confirmation_codestring required -
starts_atstring requiredISO-8601 UTC instant.
-
starts_at_localstring requiredVenue wall-clock,
YYYY-MM-DDTHH:MM. -
service_datestring requiredThe venue service day the booking belongs to,
YYYY-MM-DD. -
duration_minutesnumber or null requiredTurn duration; null on provider-managed bookings, where Maple never invents one.
-
party_sizenumber required -
guestobject required -
guest.first_namestring or null required -
guest.last_namestring or null required -
guest.phonestring or null requiredE.164, when the guest left one.
-
guest.phone_last_fourstring or null required -
guest.emailstring or null required -
notesstring or null requiredThe guest-facing note; venue-internal notes are never exposed.
-
channelstring requiredThe channel the booking originated on, e.g.
api_partner,voice_ai,internal. -
providerstring requiredOne of
maple,opentable,resy,sevenrooms. -
cancellation_policyobject or null required -
cancellation_policy.typestring required -
cancellation_policy.currencystring or null requiredISO-4217.
-
cancellation_policy.policy_textstring or null required -
cancellation_policy.tiersobject[] required -
cancellation_policy.tiers[].within_hours_before_startnumber required -
cancellation_policy.tiers[].basisstring requiredper_partyorper_person. -
cancellation_policy.tiers[].amount_centsnumber or null required -
cancellation_policy.tiers[].percent_bpsnumber or null requiredBasis points of the party value, when the fee is a percentage.
-
cancellation_policy.depositobject or null required -
cancellation_policy.deposit.amount_centsnumber required -
cancellation_policy.deposit.currencystring required -
cancellation_policy.deposit.basisstring required -
experienceobject or null requiredThe experience booked (prix fixe, ticketed seating), or null for a standard reservation.
-
experience.idstring required -
experience.namestring or null requiredNull when Maple has not seen the name.
-
updated_atstring requiredISO-8601 UTC instant.
Errors
-
400Bad request -
401Unauthorized -
403Forbidden -
404Not found -
409Conflict -
422Unprocessable -
429Too many requests
Every error body names the error in _tag, explains it in message, and says where to report it in feedback. See Errors.
A 429 also sends Retry-After: Seconds to wait before retrying; also returned as retry_after in the body.