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

A link that adds the appointment to the customer's calendar

POST /businesses/{bid}/appointments/{id}/invite

Requires the businesses scope.

Answers a signed path (/cal/<token>.ics) to send the customer. Opened, it returns the appointment as an .ics file, which a phone offers to add to its own calendar. The event is read when the link is opened, so a moved visit opens at its new hour and a cancelled one as cancelled. The token carries only the appointment id and a signature.

Path parameters

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

Response

200: { "ok": true, … }

FieldTypeDescription
okbooleanrequired
tokenstringrequiredThe signed token.
pathstringThe path to send, on this API's host: /cal/<token>.ics.

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

PreviousUndo "no document needed" NextList expenses
On this page
Path parametersResponse
POST /businesses/{bid}/appointments/{id}/invite 
curl -X POST "$BASE/businesses/$BID/appointments/$DOC_ID/invite" \
  -H "X-Api-Key: $KEY"
const res = await fetch(`${BASE}/businesses/${BID}/appointments/${DOC_ID}/invite`, {
  method: 'POST',
  headers: {
    'X-Api-Key': KEY,
  },
})
const data = await res.json()
if (!data.ok) throw new Error(data.reason)
import requests
res = requests.post(
    f"{BASE}/businesses/{BID}/appointments/{DOC_ID}/invite",
    headers={"X-Api-Key": KEY},
)
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.