POST /appointments
Create an appointment.
Servers
- https://acuityscheduling.com/api/v1
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 |
|---|---|---|---|
calendarID |
Integer | No |
Calendar ID. If not provided we'll try to find an available calendar automatically. |
labels[] |
Array | No |
An array of label objects. Currently only accepts an array of length 1. |
fields[] |
Array | No |
A special field for setting form field values. |
fields[].label |
String | No |
An array of label objects. Currently only accepts an array of length 1 |
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 omitted or set to false on an applicable Appointment, an SMS reminder will not be sent. For more information on SMS Opt In settings for Appointment Types, see the article in our Knowledge Base. Default value: false |
appointmentTypeID |
Integer | Yes |
Appointment type id. |
timezone |
String | No |
Client timezone. |
email |
String | Yes |
Client e-mail address. Optional for admins. |
certificate |
String | No |
Package or coupon certificate code. |
notes |
String | No |
Settable when booking as an admin. |
lastName |
String | Yes |
Client last name. |
phone |
String | No |
Client phone number, may be required in account settings. Optional for admins. |
addonIDs |
Integer | No |
ID of the addon(s) to be included in the scheduled appointment |
datetime |
String | Yes |
Required date and time for the appointment, parsed by strtotime in the business timezone. (http://php.net/manual/en/function.strtotime.php) |
firstName |
String | Yes |
Client first name. |
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.