Update Service

PUT 
/calendars/services/catalog/:serviceId

Update service by ID.

Request

Version stringrequired

API Version

Available optionsv3

serviceId stringrequired

Service ID

application/json

application/json

Body

Bodyrequired

namestring

Service name

descriptionstring

Service description

slugstring

Unique URL-friendly identifier

eventColorstring

Service event color (hex)

coverImagestring

Service cover image URL

serviceCategoryIdstring

Service category ID

paymentobject

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

serviceDurationnumber

This controls the duration of the appointment

serviceDurationUnitstring
Duration unit
Available optionsminshours
preBuffernumber

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

preBufferUnitstring
Pre-buffer unit
Available optionsminshours
postBuffernumber

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

postBufferUnitstring
Post-buffer unit
Available optionsminshours
isPrivateboolean

Whether service is private (not shown publicly)

formIdstring

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

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.

Example (auto)

{
  "name": "Hair Styling",
  "description": "Full hair styling session",
  "slug": "hair-styling",
  "eventColor": "#66C61C",
  "coverImage": "https://example.com/cover.jpg",
  "serviceCategoryId": "65e5f6dfacf123513228d381",
  "payment": {
    "amount": 50,
    "deposit": 20,
    "depositType": "amount"
  },
  "serviceDuration": 60,
  "serviceDurationUnit": "mins",
  "preBuffer": 10,
  "preBufferUnit": "mins",
  "postBuffer": 15,
  "postBufferUnit": "mins",
  "isPrivate": false,
  "formId": "65e5f6dfacf123513228d390",
  "staff": [
    {
      "id": "65e5f6dfacf123513228d384"
    }
  ],
  "variations": [
    {
      "id": "65e5f6dfacf123513228d385",
      "name": "Standard Haircut",
      "serviceDuration": 30
    }
  ]
}

application/json

Service updated successfully

application/json

Schema

Schema

serviceobjectrequired

Service details

Example (auto)

{
  "service": {
    "id": "65e5f6dfacf123513228d384",
    "locationId": "0007BWpSzSwfiuSl0tR2",
    "name": "Hair Styling"
  }
}