CreateAppointmentRequest | SavvyCal Appointments

Request schema for creating an appointment

Example

{  "client_data": {    "email": "john.doe@example.com",    "first_name": "John",    "last_name": "Doe",    "locale": "en-US",    "phone": "+15551234567",    "reference_id": "1234567890",    "time_zone": "America/New_York"  },  "end_at": "2025-03-01T11:00:00-05:00",  "service_id": "srv_1234567890",  "start_at": "2025-03-01T10:00:00-05:00",  "time_zone": "America/New_York",  "validate_slot": true}

client_data*

Information about the client booking the appointment. You can either provide an id or reference_id for an existing client, or provide a new client's details.

Example

{  "email": "john.doe@example.com",  "fields": {    "age": 30  },  "first_name": "John",  "last_name": "Doe",  "locale": "en-US",  "phone": "+15551234567",  "reference_id": "1234567890",  "time_zone": "America/New_York"}

end_at*string

The end time of the appointment as an ISO-8601 datetime string with a timezone offset (e.g., 2025-03-01T11:00:00-05:00 or 2025-03-01T16:00:00Z). The time_zone field determines the canonical timezone.

Formatdate-time

Example"2025-03-01T11:00:00-05:00"

provider_id?|

The ID of the provider to assign to the appointment. If not provided, an available provider will be randomly assigned.

service_id*string

The ID of the service for this appointment.

start_at*string

The start time of the appointment as an ISO-8601 datetime string with a timezone offset (e.g., 2025-03-01T10:00:00-05:00 or 2025-03-01T15:00:00Z). The time_zone field determines the canonical timezone.

Formatdate-time

Example"2025-03-01T10:00:00-05:00"

time_zone*string

The local time zone for the appointment (IANA format).

Example"America/New_York"

validate_slot?boolean

Whether to validate the slot availability for the appointment.

Defaulttrue