Skip to main content
PUT
Update a service

Authorizations

x-api-key
string
header
required

API key minted in the MarketBox dashboard. Scope is restricted to the projects you select at creation time. Every route needs the key's standard API access (*) except POST /v1/projects/{projectId}/events, which needs events:write; a key without * is refused with 403 CAPABILITY_NOT_GRANTED.

Path Parameters

projectId
string
required

The project (tenant) that owns the resource. Every resource in this API is scoped to a project, and your API key is restricted to the projects it was issued for — a project outside that scope returns 403.

Minimum string length: 1
Example:

"prj_01kv60qgnef2kt3pvqgwmkbzfr"

serviceId
string
required

The service — the sellable thing (a lesson, a treatment). Offerings hang off a service and carry the duration and price.

Minimum string length: 1
Example:

"srv_01kv60qg12e82acr78edfnjhvv"

Body

application/json

Update data

name
object
description
object
primaryLanguage
string
Minimum string length: 1
categoryId
string
taxSettings
object
participantSettings
object

Participant interaction settings: what suppliers and clients may do with, and see on, bookings of this service. Replaced whole on update — send every field, except client.participantDisplay: omitted, it keeps its stored value. Enforced for supplier- and client-role callers; API-key (integrator) calls act for the business and are not restricted by it.

Example:
bufferBeforeStartMinutes
integer

Minutes a supplier needs free before this service starts. Used for suggestions and checks only, never as busy time.

Required range: 0 <= x <= 120
Example:

10

Response

Updated service

data
object
required