Rivier/ Reference/ bookings

Book from a hold or a quote

post/public/bookings/book

Book from a hold or a quote; answers with the booking, its terms and a link to manage it.

Before you call

Credential
Authorization: Bearer $KEY
Scope
bookings:read
Graphql
Mutation.createPublicBooking
Sdk
bookings.public.book
Cli
bookings public book
Events
bookings.booking.created
Publishable
yes

Request bodyapplication/json, required

  • serviceIdstring (uuid)required
  • startstring (date-time)required
  • durationMinutesinteger
    At least 5. At most 1440.
  • partySizeinteger
    Default: 1. At least 1. At most 10000.
  • resourceIdslist of string (uuid)
  • sessionIdstring (uuid)
  • quotestring
    At most 4000 characters.
  • holdIdstring (uuid)
  • contactobjectrequired
    • namestringrequired
      At most 160 characters.
    • emailstring (email)
      At most 254 characters.
    • phonestring
      Pattern: ^+?[0-9 ()-]{6,20}$.
    • localestring
      At most 20 characters.
  • consentobject
    Default: {}.
    • emailboolean
    • smsboolean
    • voiceboolean
    • whatsappboolean
  • intakeobject
    Default: {}.
  • notesstring
    Default: . At most 2000 characters.
  • channelstring
    One of: owner, widget, api, mcp, phone, chat, import. Default: api.
  • idempotencyKeystringrequired
    At most 120 characters.

Responses

  • 201application/json
    Success
    • 400application/json
      The request was malformed
      • errorstringrequired
      • messagestring
    • 401application/json
      No valid credential
      • errorstringrequired
      • messagestring
    • 403application/json
      The credential lacks the scope, origin or address
      • errorstringrequired
      • messagestring
    • 429application/json
      Over the key's rate limit; see Retry-After
      • errorstringrequired
      • messagestring

    This page as Markdown