Skip to main content
POST
Create Service

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Body

application/json

Schema for creating a new service - ID is optional, backend generates if not provided

id
string | null
name
string | null
duration
integer | null
description
string | null
price
integer | null
displayPrice
integer | null
displayPriceMax
integer | null
priceStartsAt
boolean | null
default:false
cost
integer | null
estimated
boolean | null
default:false
bookingFee
integer | null
bookingFeeText
string | null
reminderMinutesBefore
integer | null
cancellationCost
integer | null
hoursBeforeCancellingCosts
integer | null
bookingFeePercentage
integer | null
cancellationFeePctWithin24h
integer | null
cancellationFeePctWithin48h
integer | null
refundBookingFeeBefore48h
boolean | null
hoursBeforeBookingFeeRefundable
integer | null
followUpMinutesAfter
integer | null
followUpSmsTemplate
string | null
reminderSmsTemplate
string | null
providerIds
string[] | null
locationIds
string[] | null
formIds
string[] | null
confirmationSmsTemplate
string | null
cancellationSmsTemplate
string | null
noShowSmsTemplate
string | null
overrideNoticeSmsTemplate
string | null
shortNoticeBlock
integer | null
visibility
enum<string> | null
default:ALL
Available options:
ALL,
NEW,
EXISTING,
NO
minutesBeforeRebookingAllowed
integer | null
color
string | null
allowIndividualProviderBooking
boolean | null
displayOrder
integer | null
reservedTimeMinutes
integer | null
category
string | null
isDoubleBookable
boolean | null
default:true
onlyBookableOverThePhone
boolean | null
default:false
creditCardRequired
boolean | null
default:false
collectCreditCard
boolean | null
default:false
autoGfeTreatments
string[] | null
Maximum array length: 11
brandName
string | null
unit
enum<string> | null
Available options:
AMPOULES,
APPLICATORS,
BOTTLES,
BOXES,
CAPSULES,
CUPS,
DOSES,
G_PER_ML,
GRAMS,
IU,
IU_PER_ML,
OUNCES,
FLUID_OUNCES,
KG,
KITS,
LITERS,
MCG,
MG,
MG_PER_ML,
ML,
MMOL,
MICROGRAM_PER_ML,
PACKS,
PAIRS,
PATCHES,
PERCENTAGE,
PIECES,
POUCHES,
ROLLS,
SACHETS,
SHEETS,
SPRAYS,
STRIPS,
SYRINGES,
TABLETS,
TABLETS_PER_DAY,
TESTS,
TUBES,
UNITS,
VIALS,
TREATMENTS,
SESSIONS,
PULSES,
JOULES,
CENTIMETERS,
THREAD_COUNT,
INJECTIONS,
WRINKLE_UNITS,
POUNDS,
FEET,
INCHES
internalNotes
string | null
sortOrder
integer | null
allowCustomPricing
boolean | null
default:false
externalId
string | null
prepTimeDuration
integer | null
prepTimeBuffer
integer | null
prepTimeName
string | null
prepTimeColor
string | null
prepProviderIds
string[] | null
checklists
ServiceChecklistItem · object[] | null
bookables
ServiceBookableItem · object[] | null

Response

Successful Response

id
string | null
name
string | null
duration
integer | null
description
string | null
price
integer | null
displayPrice
integer | null
displayPriceMax
integer | null
priceStartsAt
boolean | null
default:false
cost
integer | null
estimated
boolean | null
default:false
bookingFee
integer | null
bookingFeeText
string | null
reminderMinutesBefore
integer | null
cancellationCost
integer | null
hoursBeforeCancellingCosts
integer | null
bookingFeePercentage
integer | null
cancellationFeePctWithin24h
integer | null
cancellationFeePctWithin48h
integer | null
refundBookingFeeBefore48h
boolean | null
hoursBeforeBookingFeeRefundable
integer | null
followUpMinutesAfter
integer | null
followUpSmsTemplate
string | null
reminderSmsTemplate
string | null
locationIds
string[] | null
providerIds
string[] | null
createdDate
string<date-time> | null
updatedDate
string<date-time> | null
formIds
string[] | null
confirmationSmsTemplate
string | null
cancellationSmsTemplate
string | null
noShowSmsTemplate
string | null
overrideNoticeSmsTemplate
string | null
shortNoticeBlock
integer | null
visibility
enum<string> | null
default:ALL
Available options:
ALL,
NEW,
EXISTING,
NO
minutesBeforeRebookingAllowed
integer | null
color
string | null
allowIndividualProviderBooking
boolean | null
displayOrder
integer | null
reservedTimeMinutes
integer | null
category
string | null
isDoubleBookable
boolean | null
default:true
onlyBookableOverThePhone
boolean | null
default:false
creditCardRequired
boolean | null
default:false
collectCreditCard
boolean | null
default:false
autoGfeTreatments
string[] | null
brandName
string | null
unit
enum<string> | null
Available options:
AMPOULES,
APPLICATORS,
BOTTLES,
BOXES,
CAPSULES,
CUPS,
DOSES,
G_PER_ML,
GRAMS,
IU,
IU_PER_ML,
OUNCES,
FLUID_OUNCES,
KG,
KITS,
LITERS,
MCG,
MG,
MG_PER_ML,
ML,
MMOL,
MICROGRAM_PER_ML,
PACKS,
PAIRS,
PATCHES,
PERCENTAGE,
PIECES,
POUCHES,
ROLLS,
SACHETS,
SHEETS,
SPRAYS,
STRIPS,
SYRINGES,
TABLETS,
TABLETS_PER_DAY,
TESTS,
TUBES,
UNITS,
VIALS,
TREATMENTS,
SESSIONS,
PULSES,
JOULES,
CENTIMETERS,
THREAD_COUNT,
INJECTIONS,
WRINKLE_UNITS,
POUNDS,
FEET,
INCHES
internalNotes
string | null
sortOrder
integer | null
allowCustomPricing
boolean | null
default:false
externalId
string | null
prepTimeDuration
integer | null
prepTimeBuffer
integer | null
prepTimeName
string | null
prepTimeColor
string | null
prepProviderIds
string[] | null
checklists
ServiceChecklistItem · object[] | null
bookables
ServiceBookableItem · object[] | null
exemptedTaxIds
string[] | null