PUT /appointments/{id}
Update an appointment details from a white-list of updatable attributes.
Servers
- https://acuityscheduling.com/api/v1
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
Integer | Yes |
Appointment ID |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
email |
String | No |
Client email. May not be removed for clients, optional for admins. |
certificate |
String | No |
Package or coupon certificate code. May only be set by admins. Learn more about booking as an admin |
notes |
String | No |
May only be set by admins. Learn more about booking as an admin. |
labels[] |
Array | No |
An array of label objects. The API currently only accepts an array of length 1. |
lastName |
String | No |
Client last name, may not be removed. |
phone |
String | No |
Client phone. May not be removed for clients depending on account settings, optional for admins. |
firstName |
String | No |
Client first name, may not be removed. |
fields[] |
Array | No |
A special field for updating form field values. |
smsOptIn |
Boolean | No |
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. Default value: false |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.