Reschedule an appointment

put

https://api-stage.onsched.com/v3/appointment/{id}/reschedule

Reschedule an existing appointment by adjusting its start/end times and/or resource assignments. Sends reschedule notifications, updates calendar events, and refreshes cache entries.

Path Params

uuid

required

Query Params

ResourceIds

array of uuids

Create query param per resource, e.g., ResourceIds=uuid1&ResourceIds=uuid2

ResourceIds

includePaddingEvent

boolean

Defaults to false

When true, creates a separate padding event in external calendars (Google Calendar, Outlook)

includeCustomerAttendee

boolean

Defaults to true

When false, the customer is not added as an attendee on the external calendar event.

ignoreExternalEvents

boolean

Defaults to false

When true, skips validation against external calendar events (reasonType EXT), allowing rescheduling even if an external calendar block exists.

Body Params

Provide a new Unavailability block and/or updated resource assignment details. Status transitions remain managed by the dedicated endpoints.

bookedBy

string

notificationSent

boolean

confirmed

boolean

notes

string

location

string

CustomFields

object

Unavailability

object

Provide new start/end times to reschedule the appointment.

resourceId

uuid

Legacy singular resource assignment. Prefer the ResourceIds query parameter.

Responses

400

Validation error (missing body or invalid combination of fields).

401

Unauthorized.

403

Forbidden.

404

Appointment not found.

Language

Credentials

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Appointment rescheduled successfully.