Create Service

POST 
/calendars/services/catalog

Create new service in a location.

Request

Version stringrequired

API Version

Available optionsv3

application/json

application/json

Body

Bodyrequired

locationIdstringrequired

Location ID

namestringrequired

Service name

slugstringrequired

Unique URL-friendly identifier

staffobject[]required

Assigned staff members (at least one required)

descriptionstring

Service description

eventColorstring

Service event color (hex)

coverImagestring

Service cover image URL

serviceCategoryIdstring

Service category ID (uses default category if not provided)

paymentobject

Payment details (default amount is 0, 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)

variationsobject[]

Service variations (pass empty array for no variations)

Example (auto)

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

application/json

Service created successfully

application/json

Schema

Schema

serviceobjectrequired

Service details

Example (auto)

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