BizKitHub
DocsInteractive API Docs/api/v1/address/update
post

/api/v1/address/update

Updates an existing address identified by ID. Only provided fields will be updated, omitted fields remain unchanged. Address is automatically validated and normalized. Requires identityId to verify the address belongs to the contact.

Endpoint Info
Base URLapi.bizkithub.com
AuthBearer Token
Methods1
Authentication Required

This endpoint requires a valid API key passed as a query parameter or Bearer token.

Get your API key

Parameters

1 query, 15 body parameters

apiKeystringrequired

Your BizKitHub API key (passed as GET parameter).

Key format: A 32-character string matching: ^(PROD|DEV_|ROOT)[A-Za-z0-9]{28}$
Prefixes: PROD (production key), DEV_ (individual developer), ROOT (system key with no limits). Learn more

identityIdstringrequired

Logged user identity (from your frontend cookies). Learn more

idstringrequired

Address external identifier (core__address.external_id).

typestring

Address type code. Common values: delivery, billing, contact, invoice.

firstNamestring

First name of the person.

lastNamestring

Last name of the person.

companyNamestring

Company name (for business addresses).

streetAddressstring

Street name and house number.

postalCodestring

Postal/ZIP code.

citystring

City name.

cityPartstring

City district or part.

stateRegionstring

State or region name.

countrystring

ISO 3166-1 alpha-2 country code.

companyRegistrationNumberstring

Company registration number (IČO in CZ).

taxIdentificationNumberstring

Tax identification number (DIČ in CZ, VAT ID in EU).

noticestring

Additional notes or delivery instructions.

Example Request

JavaScript fetch

const response = await fetch("https://api.bizkithub.com/api/v1/address/update?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "identityId": "Z9CPkS2o3UV163VQn5OUv0T8BQi8Fvdg",
    "id": "6IU2SWgP76FO2UXw",
    "type": "delivery",
    "firstName": "example_firstName",
    "lastName": "example_lastName",
    "companyName": "example_companyName",
    "streetAddress": "example_streetAddress",
    "postalCode": "example_postalCode",
    "city": "example_city",
    "cityPart": "example_cityPart",
    "stateRegion": "example_stateRegion",
    "country": "CZ",
    "companyRegistrationNumber": "example_companyRegistrationNumber",
    "taxIdentificationNumber": "example_taxIdentificationNumber",
    "notice": "example_notice"
  })
});

const data = await response.json();
console.log(data);
post

Example Response

200Success
{
  "id": "6IU2SWgP76FO2UXw",
  "type": "delivery",
  "firstName": "example_firstName",
  "lastName": "example_lastName",
  "companyName": "example_companyName",
  "companyRegistrationNumber": "example_companyRegistrationNumber",
  "taxIdentificationNumber": "example_taxIdentificationNumber",
  "streetAddress": "example_streetAddress",
  "city": "example_city",
  "cityPart": "example_cityPart",
  "stateRegion": "example_stateRegion",
  "postalCode": "example_postalCode",
  "country": "CZ",
  "notice": "example_notice"
}

cURL

Command line example

curl -X POST "https://api.bizkithub.com/api/v1/address/update?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE" \
  -H "Content-Type: application/json" \
  -d '{
  "identityId": "Z9CPkS2o3UV163VQn5OUv0T8BQi8Fvdg",
  "id": "6IU2SWgP76FO2UXw",
  "type": "delivery",
  "firstName": "example_firstName",
  "lastName": "example_lastName",
  "companyName": "example_companyName",
  "streetAddress": "example_streetAddress",
  "postalCode": "example_postalCode",
  "city": "example_city",
  "cityPart": "example_cityPart",
  "stateRegion": "example_stateRegion",
  "country": "CZ",
  "companyRegistrationNumber": "example_companyRegistrationNumber",
  "taxIdentificationNumber": "example_taxIdentificationNumber",
  "notice": "example_notice"
}'

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key
Back to API DocumentationAPI Reference