HomeBook an Intro CallStartup Program
API Endpoints

Update an appointment

put
https://api-stage.onsched.com/v3/appointment/

Update appointment metadata fields without altering schedule or resource assignments.
overridePadding is supported for IN, RS, and BK appointments. Increasing effective
padding revalidates availability; decreasing it does not. Set it to null to restore the
Service padding or to 0 to disable padding. Padding-only updates do not emit appointment
lifecycle notifications or webhooks.
Use the /reschedule endpoint for time/resource changes.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params

Update appointment metadata (notes, reminders, custom fields) or overridePadding.
Do not include a status or Unavailability property; statuses are managed via /hold, /book, /confirm, and /cancel,
and rescheduling is handled via /v3/appointment/{id}/reschedule.

string
integer | null
0 to 2147483647

Appointment-specific padding in minutes. Omit to preserve the current value, set null to restore Service padding, or set 0 to disable padding.

boolean

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

boolean
string
string
CustomFields
object
Responses

400

Invalid body or query parameters, unsupported appointment status, or increased padding is unavailable.

401

Unauthorized.

403

Forbidden.

404

Appointment not found.

Updated 4 months ago

Did this page help you?
Language
Credentials
Required Scopes
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?