Skip to main content
ServicesVersion: v3

Create Service

POST/calendars/services/catalog

Create new service in a location.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:calendars.write
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3
Example:v3

Body

application/json
locationIdstringrequired

Location ID

Example:0007BWpSzSwfiuSl0tR2
namestringrequired

Service name

Example:Hair Styling
slugstringrequired

Unique URL-friendly identifier

Example:hair-styling
staffobject[]required

Assigned staff members (at least one required)

descriptionstring

Service description

Example:Full hair styling session
eventColorstring

Service event color (hex)

Example:#66C61C
coverImagestring

Service cover image URL

Example:https://example.com/cover.jpg
serviceCategoryIdstring

Service category ID (uses default category if not provided)

Example:65e5f6dfacf123513228d381
paymentobject

Payment details (default amount is 0, currency configured in Service Global Settings is used.)

serviceDurationnumber

This controls the duration of the appointment

Example:30
serviceDurationUnitstring

Duration unit

Available optionsminshours
Example:mins
preBuffernumber

Pre-Buffer is additional time that can be added before an appointment, allowing for extra time to get ready

Example:10
preBufferUnitstring

Pre-buffer unit

Available optionsminshours
Example:mins
postBuffernumber

Post-buffer: Additional time that can be added after an appointment, allowing for extra time to wrap up

Example:15
postBufferUnitstring

Post-buffer unit

Available optionsminshours
Example:mins
isPrivateboolean

Whether service is private (not shown publicly)

Example:false
formIdstring

Custom form ID (will be used to display the custom form on the booking page, if only one service is selected)

Example:65e5f6dfacf123513228d390
variationsobject[]

Service variations (pass empty array for no variations)

Response

application/json

Service created successfully

serviceobjectrequired

Service details