/bff/address/create

Creates a new address record and links it to a contact identified by contactId.

AddresspostBffAddressCreate

Parameters

15 body

15 total

Body · 15

idstring

External address ID. Required for update, optional for create.

typestring

Address type: accounting, billing, deliveryGoods or deliveryInvoice.

contactIdstring

Contact external reference number to link address to.

firstNamestring

First name.

lastNamestring

Last name.

companyNamestring

Company name.

streetAddressstring

Street and house number.

postalCodestring

Postal / ZIP code.

citystring

City name.

cityPartstring

City part or district.

stateRegionstring

State or region.

countrystring

ISO 3166-1 alpha-2 country code.

companyRegistrationNumberstring

Company registration number (IČO).

taxIdentificationNumberstring

Tax identification number (DIČ).

noticestring

Internal note about the address.

Request

POST /bff/address/create

post

curl -X POST "https://api.bizkithub.com/bff/address/create" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "id": "addr_abc123",
  "type": "billing",
  "contactId": "cu_xyz789",
  "firstName": "Jan",
  "lastName": "Novák",
  "companyName": "Acme s.r.o.",
  "streetAddress": "Vodičkova 36",
  "postalCode": "11000",
  "city": "Praha",
  "cityPart": "example_cityPart",
  "stateRegion": "example_stateRegion",
  "country": "CZ",
  "companyRegistrationNumber": "05103118",
  "taxIdentificationNumber": "CZ9609040727",
  "notice": "example_notice"
}'

Response

JSON payload

{
  "success": true
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key