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

Move or edit an appointment

PATCH /businesses/{bid}/appointments/{id}

Requires the businesses scope.

Day, time, place, customer, service, price, notes. Never the status: moving an appointment does not change whether it happened.

Path parameters

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

Body

FieldTypeDescription
partyIdstringA saved party (find or create it first). Optional: a block of time needs no customer.
serviceIdstring
titlestring≤120 chars. Default: the service, else the customer, else "פגישה".
datestringYYYY-MM-DD, the Israel calendar day.
startstringHH:MM, local Israel time.
minutesinteger5..1440. Default: the service, else the calendar's defaultMinutes.
priceAgorotintegerInteger agorot (₪1 = 100).
priceModestringOne of: gross, net. Default gross.
locationstringDefault: the calendar's first location. One of: business, customer, remote.
addressstring≤300 chars.
meetingUrlstringAn http(s) address.
notesstring≤2000 chars.

Response

200: { "ok": true, … }

FieldTypeDescription
okbooleanrequired
appointmentAppointmentrequiredAn appointment on the business's calendar. Not a document: freely edited and deleted, in no export.

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).

PATCH /businesses/{bid}/appointments/{id}
curl -X PATCH "$BASE/businesses/$BID/appointments/$DOC_ID" \
  -H "X-Api-Key: $KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "priceMode": "gross"
  }'
const res = await fetch(`${BASE}/businesses/${BID}/appointments/${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}/appointments/{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.