RescheduleAppointmentRequest

Request schema for rescheduling an appointment

end_atstring<date-time>required

The new 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.

Example: 2025-03-01T11:00:00-05: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_atstring<date-time>required

The new 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.

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

time_zonestringrequired

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

Example: America/New_York

RescheduleAppointmentRequest

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