BizKitHub
DocsAPI ReferenceContact/bff/contact/set-primary-address
postContactAdmin BFF

/bff/contact/set-primary-address

Sets which of the contact's addresses is the default (primary) address used to pre-fill new orders and invoices. The addressId must reference an address that belongs to this contact.

ContactpostBffContactSet-primary-address

Parameters

JSON body

Request body

application/json
customerIdstringRequired

Contact external ID.

Exampleabc123def456ghij
addressIdstringRequired

Address external ID that should become the contact's primary address. Must belong to this contact.

Exampleaddr_abc123

Response schema

1 status code documented

200Success
successbooleanRequired
Default: true
alreadyPrimarybooleanRequired
Default: false

Response example

application/json
{
  "success": true,
  "alreadyPrimary": false
}

Request example

POST /bff/contact/set-primary-address

post
curl -X POST "https://api.bizkithub.com/bff/contact/set-primary-address" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "customerId": "abc123def456ghij",
  "addressId": "addr_abc123"
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key