Skip to main content
ServicesVersion: v3

Update Service

PUT/calendars/services/catalog/{serviceId}

Update service by ID.

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

Path Parameters

serviceIdstringrequired

Service ID

Example:65e5f6dfacf123513228d384

Body

application/json
namestring

Service name

Example:Hair Styling
descriptionstring

Service description

Example:Full hair styling session
slugstring

Unique URL-friendly identifier

Example:hair-styling
eventColorstring

Service event color (hex)

Example:#66C61C
coverImagestring

Service cover image URL

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

Service category ID

Example:65e5f6dfacf123513228d381
paymentobject

Payment details (currency configured in Service Global Settings is used.)

serviceDurationnumber

This controls the duration of the appointment

Example:60
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
staffobject[]

Assigned staff members

variationsobject[]

Service variations (an empty array removes all variations). Include an id to update an existing variation; omit the id to create a new one.

Response

application/json

Service updated successfully

serviceobjectrequired

Service details