Reschedule an appointment

put

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

Reschedule an existing appointment by adjusting its start/end times, resource assignments, or both.
Resource-only changes use the same lifecycle: the original appointment becomes RE, a new appointment is created,
reschedule webhooks are emitted, calendar events are refreshed, and cache entries are cleared. Email and SMS
notifications are emitted unless the request includes skip_notifications: true.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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, updated resource assignment details, or both.
For a resource-only change at the same time, pass ResourceIds as query parameters and omit Unavailability.
Set skip_notifications: true to suppress email and SMS for this reschedule; webhooks and external calendar synchronization still run.
Status transitions remain managed by the dedicated endpoints.

bookedBy

string

notificationSent

boolean

Reminder delivery state. This field does not suppress appointment lifecycle notifications; use skip_notifications on the reschedule endpoint instead.

confirmed

boolean

notes

string

location

string

CustomFields

object

skip_notifications

boolean

Defaults to false

When true, suppresses reschedule email and SMS notifications for customer, company, and resource recipients. Reschedule webhooks and external calendar synchronization still run.

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), a ResourceIds entry that is not a resource of this company or is not linked to the appointment's location and service, or the new slot is unavailable.

401

Unauthorized.

403

Forbidden.

404

Appointment not found.

Language

Credentials

Loading…

Response

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

application/json

200Appointment rescheduled successfully.