Book an appointment

Creates a booking for the given appointment type and slot. Only free appointment types can be booked through this API; a paid appointment type (see pricing_type on the appointment type) returns 400, since paid appointments can only be booked through the site's cart and checkout UI, which collects payment first. On conflict the API returns 400 (the host already has a booking at this time or is not available); the agent should re-query /availability and pick a different slot.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
string
required

Duda id of the appointment type to book. Required.

attendee
object
required

Attendee details. Required.

booking_fields_responses
object

Free-form custom-field responses configured on the appointment type.

int32

Override slot duration in minutes. Only for variable-length event types.

guests
array of strings

Extra guest emails to CC on confirmation.

guests
metadata
object

Caller-supplied metadata stored with the appointment. Useful for agent attribution.

string
required

Slot start time, ISO 8601 UTC. Required.

Responses

401

Unauthorized request - missing or invalid credentials

429

Rate limit exceeded - please refer to api documentation for limits

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