Create New Booking [Business]

Overview

Create a new booking (appointment or event attendance). Available for Staff, Directory, and Application tokens.

Important: Always provide client_id parameter. Without it, the endpoint attempts to create a client from form_data and returns 'First name can't be blank' errors.

Token Authorization

  • Staff tokens: Client must belong to the same business as the staff member
  • Directory tokens: Business must be a member of the directory (requires directory_member record)

Booking Types

This endpoint supports two types of bookings with different required parameters:

Appointment Booking (default)

When event_instance_id is NOT provided:

  • Required: business_id, service_id, staff_id
  • Required one of: start_time OR optional_times

Event Registration

When event_instance_id IS provided:

  • Required: business_id, event_instance_id

Client Identification

  • Use client_id to book for an existing client (required for Staff/App tokens)
  • Without client_id, the endpoint expects form_data for client creation (used by client-facing booking flows)
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer

Optional for appointment only. Arrival window value is in minutes and limited to 540 (9 hours).

string
required

Business uid. Always required.

string

Source campaign for tracking.

string

Source channel for tracking.

string

Client uid. Recommended when booking on behalf of a client via Staff/App tokens.

string

Event instance uid. Required for event registration (mutually exclusive with service_id/staff_id/start_time).

string

Address. Required when service location is set to: Client will set the address at booking.

string

Matter/conversation uid to associate with the booking.

string

Service uid. Required for appointment booking.

string

Source name for tracking (e.g., 'api', 'client_portal').

string

Source URL for tracking.

string

Staff uid who will provide the service. Required for appointment booking.

date-time

ISO 8601 format datetime. Required for appointment booking (alternative: optional_times).

string

Time zone for the booking. Default is UTC if not provided.

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json