BillOS v1
Console llms.txt OpenAPI
PATCH/businesses/{bid}/services/{id}

Edit or hide a service

PATCH /businesses/{bid}/services/{id}

Requires the businesses scope.

A service is never deleted once it exists (appointments point at it): active: false takes it off the picker.

Path parameters

NameTypeDescription
bidstringrequiredBusiness id, from POST /businesses.
idstringrequiredService id.

Body

FieldTypeDescription
namestringRequired on create. ≤120 chars.
minutesinteger5..1440. Default 60.
priceAgorotintegerInteger agorot (₪1 = 100).
priceModestringOne of: gross, net. Default gross.
colorstring#RRGGBB
activeboolean
sortOrderinteger

Response

200: { "ok": true, … }

FieldTypeDescription
okbooleanrequired
serviceServicerequiredSomething the business sells by the appointment. Picking it fills an appointment's length, price and title.

Errors: 400, 401, 403, 404, 429. Every failure answers { "error", "reason", "hint", "param", "doc_url", "retryable", "request_id" }: branch on reason, and read hint for what to change (https://docs.billos.co.il/errors.md).

PreviousAdd a service NextList appointments in a window
On this page
Path parametersBodyResponse
PATCH /businesses/{bid}/services/{id} 
curl -X PATCH "$BASE/businesses/$BID/services/$DOC_ID" \
  -H "X-Api-Key: $KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "priceMode": "gross"
  }'
const res = await fetch(`${BASE}/businesses/${BID}/services/${DOC_ID}`, {
  method: 'PATCH',
  headers: {
    'X-Api-Key': KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "priceMode": "gross"
  }),
})
const data = await res.json()
if (!data.ok) throw new Error(data.reason)
import requests
res = requests.patch(
    f"{BASE}/businesses/{BID}/services/{DOC_ID}",
    headers={"X-Api-Key": KEY},
    json={
      "priceMode": "gross"
    },
)
data = res.json()
Set BASE to https://api.billos.co.il/v1 and KEY to your bk_live_… key, or a bk_test_… key to run it against the sandbox.
Manage your businesses, keys and webhooks in the BillOS Console.