Book a held time

POST

/public/v1/bookings

curl --request POST \
  --url https://example.kwickbooking.com/public/v1/bookings \
  --header 'Content-Type: application/json' \
  --header 'X-KB-Publishable-Key: <X-KB-Publishable-Key>' \
  --data '{ "holdId": "01920000-0000-7000-8000-000000000010", "venueId": "01920000-0000-7000-8000-000000000001", "guestId": "01920000-0000-7000-8000-000000000011", "contactId": "01920000-0000-7000-8000-000000000012", "partySize": 2, "notes": null, "bookingForBusiness": false }'

• Your deployment

Turns a hold into a booking. When the venue takes a deposit the reply has a checkout link; otherwise the booking is confirmed at once. Send an Idempotency-Key header.

Authorizations

• PublishableKey

Request Body^required

Media typeapplication/json

Request to create a booking from a held slot.

object

holdId

required

string format: uuid

venueId

required

string format: uuid

guestId

required

null | string format: uuid

contactId

required

null | string format: uuid

partySize

required

integer format: int32

notes

required

null | string

bookingForBusiness

required

boolean

Example

{
  "holdId": "01920000-0000-7000-8000-000000000010",
  "venueId": "01920000-0000-7000-8000-000000000001",
  "guestId": "01920000-0000-7000-8000-000000000011",
  "contactId": "01920000-0000-7000-8000-000000000012",
  "partySize": 2,
  "notes": null,
  "bookingForBusiness": false
}

Responses

201

Created

Media typeapplication/json

A booking made from a hold: its state, the checkout link when a deposit is due, and its reference.

object

bookingId

required

string format: uuid

state

required

string

checkoutUrl

required

null | string

reference

null | string

Example

{
  "bookingId": "01920000-0000-7000-8000-000000000010",
  "state": "Confirmed",
  "checkoutUrl": null,
  "reference": "48271936"
}

400

Validation failed (https://developers.kwickblocks.ai/problems/validation-failed); Idempotency-Key required (https://developers.kwickblocks.ai/problems/idempotency-key-required)

Media typeapplication/problem+json

RFC 9457 problem details. type is a URI with a page describing the problem.

object

type

required

string format: uri

title

required

string

status

required

integer format: int32

detail

required

Safe to read to a guest.

string

instance

string

traceId

string

code

A machine-readable code on the widget’s routes.

string

Examples

Validation failed

{
  "type": "https://developers.kwickblocks.ai/problems/validation-failed",
  "title": "Validation failed",
  "status": 400,
  "detail": "Some of the details weren't valid. Please check them and try again."
}

Idempotency-Key required

{
  "type": "https://developers.kwickblocks.ai/problems/idempotency-key-required",
  "title": "Idempotency-Key required",
  "status": 400,
  "detail": "This request needs an Idempotency-Key header."
}

401

Invalid or missing integration key (https://developers.kwickblocks.ai/problems/invalid-key)

Media typeapplication/problem+json

RFC 9457 problem details. type is a URI with a page describing the problem.

object

type

required

string format: uri

title

required

string

status

required

integer format: int32

detail

required

Safe to read to a guest.

string

instance

string

traceId

string

code

A machine-readable code on the widget’s routes.

string

Examples

Exampleinvalid-key

Invalid or missing integration key

{
  "type": "https://developers.kwickblocks.ai/problems/invalid-key",
  "title": "Invalid or missing integration key",
  "status": 401,
  "detail": "This integration key isn't valid. Ask the venue's admin for a new one."
}

404

Not found (https://developers.kwickblocks.ai/problems/not-found)

Media typeapplication/problem+json

RFC 9457 problem details. type is a URI with a page describing the problem.

object

type

required

string format: uri

title

required

string

status

required

integer format: int32

detail

required

Safe to read to a guest.

string

instance

string

traceId

string

code

A machine-readable code on the widget’s routes.

string

Examples

Examplenot-found

Not found

{
  "type": "https://developers.kwickblocks.ai/problems/not-found",
  "title": "Not found",
  "status": 404,
  "detail": "I couldn't find that."
}

409

Idempotency-Key conflict (https://developers.kwickblocks.ai/problems/idempotency-conflict)

Media typeapplication/problem+json

RFC 9457 problem details. type is a URI with a page describing the problem.

object

type

required

string format: uri

title

required

string

status

required

integer format: int32

detail

required

Safe to read to a guest.

string

instance

string

traceId

string

code

A machine-readable code on the widget’s routes.

string

Examples

Exampleidempotency-conflict

Idempotency-Key conflict

{
  "type": "https://developers.kwickblocks.ai/problems/idempotency-conflict",
  "title": "Idempotency-Key conflict",
  "status": 409,
  "detail": "That Idempotency-Key was already used for a different request."
}

429

Too many requests (https://developers.kwickblocks.ai/problems/rate-limited)

Media typeapplication/problem+json

RFC 9457 problem details. type is a URI with a page describing the problem.

object

type

required

string format: uri

title

required

string

status

required

integer format: int32

detail

required

Safe to read to a guest.

string

instance

string

traceId

string

code

A machine-readable code on the widget’s routes.

string

Examples

Examplerate-limited

Too many requests

{
  "type": "https://developers.kwickblocks.ai/problems/rate-limited",
  "title": "Too many requests",
  "status": 429,
  "detail": "There have been too many requests. Please try again in a minute."
}