Skip to content

Set Customer Address as Default

EndpointMethod
/api/admin/customers/{customerId}/addresses/{id}/set-defaultPOST

Marks the chosen address as the customer's default. All the customer's other addresses have their default flag cleared in the same call. The request body is empty.

Path Parameters

ParameterTypeRequiredDescription
customerIdintegeryesThe customer who owns the address.
idintegeryesThe address to make default. Must belong to customerId (otherwise 403). Unknown address → 404.

Response

Returns the updated address detail (same shape as the address detail endpoint), with defaultAddress: true.

Permission: customers.addresses.edit.

TIP

For default-address semantics and the address-book overview, see the Addresses overview.

All admin endpoints require an admin Bearer token — see Authentication.

Released under the MIT License.