BillOS v1
Console llms.txt OpenAPI
POST/businesses/{bid}/parties/{id}/contacts

Add a contact to a party

POST /businesses/{bid}/parties/{id}/contacts

Requires the businesses scope.

A contact needs a phone or an email. A party holds at most 20.

Path parameters

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

Body

FieldTypeDescription
namestring
rolestringbilling, site, manager, other, or your own words.
phonestring
emailstring

Response

201: { "ok": true, … }

FieldTypeDescription
okbooleanrequired
contactPartyContactrequiredA person at a customer: an accounts department, a second mobile, who opens the site. Reach only: documents still name the party, and no report or export reads a contact.

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

PreviousList a party's contacts NextUpdate a contact
On this page
Path parametersBodyResponse
POST /businesses/{bid}/parties/{id}/contacts 
curl -X POST "$BASE/businesses/$BID/parties/$DOC_ID/contacts" \
  -H "X-Api-Key: $KEY"
const res = await fetch(`${BASE}/businesses/${BID}/parties/${DOC_ID}/contacts`, {
  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}/parties/{DOC_ID}/contacts",
    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.