/appointments

post

https://acuityscheduling.com/api/v1/appointments

Create an appointment.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

datetime

string

required

Required date and time for the appointment, parsed by strtotime in the business or calendar timezone. (http://php.net/manual/en/function.strtotime.php)

appointmentTypeID

int32

required

Appointment type id.

calendarID

int32

Calendar ID. If not provided we'll try to find an available calendar automatically.

firstName

string

required

Client first name.

lastName

string

required

Client last name.

string

required

Client e-mail address. Optional for admins.

phone

string

Client phone number, may be required in account settings. Optional for admins.

timezone

string

Client timezone.

certificate

string

Package or coupon certificate code.

fields

array of objects

A special field for setting form field values.

fields

notes

string

Settable when booking as an admin.

addonIDs

int32

ID of the addon(s) to be included in the scheduled appointment

labels

array

An array of label objects. 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 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.

Responses

Language

Credentials

Basic

base64

Loading…

Response

Choose an example:

application/json

200200

400400