BizKitHub
DocsAPI ReferenceAddress/bff/address/update
postAddressAdmin BFF

/bff/address/update

Updates an existing address record. The address ID must be provided in the body.

AddresspostBffAddressUpdate

Parameters

JSON body

Request body

application/json
idstringOptional

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

Exampleaddr_abc123
typestringOptional

Address type: accounting, billing, deliveryGoods or deliveryInvoice.

Examplebilling
contactIdstringOptional

Contact external reference number to link address to.

Examplecu_xyz789
firstNamestringOptional

First name.

ExampleJan
lastNamestringOptional

Last name.

ExampleNovák
companyNamestringOptional

Company name.

ExampleAcme s.r.o.
streetAddressstringOptional

Street and house number.

ExampleVodičkova 36
postalCodestringOptional

Postal / ZIP code.

Example11000
citystringOptional

City name.

ExamplePraha
cityPartstringOptional

City part or district.

stateRegionstringOptional

State or region.

countrystringOptional

ISO 3166-1 alpha-2 country code.

ExampleCZ
companyRegistrationNumberstringOptional

Company registration number (IČO).

Example05103118
taxIdentificationNumberstringOptional

Tax identification number (DIČ).

ExampleCZ9609040727
noticestringOptional

Internal note about the address.

Response schema

1 status code documented

200Success
successbooleanRequired
Default: true

Response example

application/json
{
  "success": true
}

Request example

POST /bff/address/update

post
curl -X POST "https://api.bizkithub.com/bff/address/update" \
  -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"
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key