Skip to main content

RescheduleAppointmentRequest

Request schema for rescheduling an appointment

end_atstringrequired

The new end time of the appointment in local time (in naive ISO-8601 format, without time zone information). The time zone for the appointment is specified in the time_zone field.

Possible values: Value must match regular expression ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$

Example: 2025-03-01T11:00:00
initiated_bystring

The entity that initiated the reschedule.

Possible values: [user, client]

Default value: client
provider_idstringnullable

The ID of the provider to assign to the appointment. If not provided, the provider assigned to the original appointment will be used.

start_atstringrequired

The new start time of the appointment in local time (in naive ISO-8601 format, without time zone information). The time zone for the appointment is specified in the time_zone field.

Possible values: Value must match regular expression ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$

Example: 2025-03-01T10:00:00
time_zonestringrequired

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

Example: America/New_York
RescheduleAppointmentRequest
{
  "end_at": "2025-03-01T11:00:00",
  "initiated_by": "client",
  "provider_id": "prv_1234567890",
  "start_at": "2025-03-01T10:00:00",
  "time_zone": "America/New_York"
}