PublicAppointment | SavvyCal Appointments

A public appointment represents a booking that a client has made with a provider for a service.

Example

{  "add_to_calendar_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar",  "cancel_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel",  "cancellation": {    "allowed": true,    "disabled_message": null  },  "confirmed_at": "2025-03-10T15:30:00Z",  "end_at": {    "local": "2025-03-01T11:00:00-05:00",    "object": "zoned_date_time",    "time_zone": "America/New_York",    "unix_ts": 1736464800,    "utc": "2025-03-01T04:00:00Z"  },  "ics_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics",  "id": "appt_a1b2c3d4e5f6",  "object": "public_appointment",  "reschedule_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule",  "rescheduling": {    "allowed": false,    "disabled_message": "Rescheduling is not available within 24 hours of your appointment"  },  "start_at": {    "local": "2025-03-01T10:00:00-05:00",    "object": "zoned_date_time",    "time_zone": "America/New_York",    "unix_ts": 1736461200,    "utc": "2025-03-01T03:00:00Z"  },  "status": "scheduled",  "urls": {    "add_to_calendar": [      "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar"    ],    "add_to_google_calendar": [      "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"    ],    "cancel": [      "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel"    ],    "ics": [      "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics"    ],    "reschedule": [      "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule"    ]  }}

add_to_calendar_url*string

Canonical URL for adding the appointment to a calendar. Resolves to the account's active custom domain when configured, otherwise the canonical app host. The host portion may change if the account changes its custom-domain configuration.

Formaturi

cancel_url*string

Canonical URL for canceling the appointment. Resolves to the account's active custom domain when configured, otherwise the canonical app host. The host portion may change if the account changes its custom-domain configuration.

Formaturi

cancellation*

Information about whether the appointment can be canceled by the client.

confirmed_at*|

Time at which the object was confirmed.

Formatdate-time

end_at*

An object describing a date/time in local time and in UTC.

Example

{  "local": "2025-03-01T10:00:00-05:00",  "object": "zoned_date_time",  "time_zone": "America/New_York",  "unix_ts": 1736461200,  "utc": "2025-03-01T03:00:00Z"}

ics_url*string

Canonical URL for downloading an ICS file for the appointment. Resolves to the account's active custom domain when configured, otherwise the canonical app host. The host portion may change if the account changes its custom-domain configuration.

Formaturi

id*string

Unique identifier for the object.

Match^appt_\w{12}$

object*"public_appointment"

String representing the object's type.

Value in

"public_appointment"

reschedule_url*string

Canonical URL for rescheduling the appointment. Resolves to the account's active custom domain when configured, otherwise the canonical app host. The host portion may change if the account changes its custom-domain configuration.

Formaturi

rescheduling*

Information about whether the appointment can be rescheduled by the client.

start_at*

An object describing a date/time in local time and in UTC.

Example

{  "local": "2025-03-01T10:00:00-05:00",  "object": "zoned_date_time",  "time_zone": "America/New_York",  "unix_ts": 1736461200,  "utc": "2025-03-01T03:00:00Z"}

status*string

The status of the appointment.

Value in

"scheduled"
"canceled"

urls*

Deprecated

Deprecated nested URL collections for this public appointment. Use the flat *_url fields instead.