/appointments/:id

put

https://acuityscheduling.com/api/v1/appointments/{id}

Update an appointment details from a white-list of updatable attributes.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int32

required

Appointment ID

Body Params

firstName

string

Client first name, may not be removed.

lastName

string

Client last name, may not be removed.

string

Client email. May not be removed for clients, optional for admins.

phone

string

Client phone. May not be removed for clients depending on account settings, optional for admins.

certificate

string

Package or coupon certificate code. May only be set by admins. Learn more about booking as an admin

fields

array

A special field for updating form field values.

fields

notes

string

May only be set by admins. Learn more about booking as an admin.

labels

array

An array of label objects. The API currently only accepts an array of length 1.

labels

smsOptIn

boolean

Defaults to false

Indicates whether the client has explicitly given their permission to receive SMS messages. This parameter is only applicable to Appointments with an Appointment Type that requires Opt In and can be omitted (and will be ignored) for all other Appointments. If set to false on an applicable Appointment, an SMS reminder will not be sent. This parameter may be omitted if you do not wish to update this field. For more information on SMS Opt In settings for Appointment Types, see the article in our Knowledge Base.

Response

200200