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

Update a business

PATCH /businesses/{bid}

Requires the businesses scope.

Profile, branding and requireAllocation. The tax id and dealer type of a business that has already issued documents are not editable.

Path parameters

NameTypeDescription
bidstringrequiredBusiness id, from POST /businesses.

Body

FieldTypeDescription
namestring
addressstring
phonestring
emailstring
requireAllocationbooleanStrict mode for allocation numbers.
brandingBrandingAppearance of the rendered PDF. Stored once per business; a logo is stored as a file and referenced by hash, never re-frozen into each document.

Response

200: { "ok": true, … }

FieldTypeDescription
okbooleanrequired
businessBusinessrequiredOne Israeli dealer (עוסק), one of your end users.

Errors: 400, 401, 403, 404, 429. Every failure answers { "error": …, "reason": … }. Branch on reason.

PreviousRead a business NextDeactivate a business
On this page
Path parametersBodyResponse
PATCH /businesses/{bid} 
curl -X PATCH "$BASE/businesses/$BID" \
  -H "X-Api-Key: $KEY"
const res = await fetch(`${BASE}/businesses/${BID}`, {
  method: 'PATCH',
  headers: {
    'X-Api-Key': KEY,
  },
})
const data = await res.json()
if (!data.ok) throw new Error(data.reason)
import requests
res = requests.patch(
    f"{BASE}/businesses/{BID}",
    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.