---
title: "Edit Address"
method: PUT
path: "/v1/account/addresses/{id}"
tags: ["Account"]
---

# Edit Address

`PUT /v1/account/addresses/{id}`

Edit an existing address in a shopper's address book.
This endpoint fully replaces the information for an existing address while retaining the same address ID.

## Path parameters

- `id` string, required

## Headers

- `X-Publishable-Key` string

## Request body

- AddressAccount — The Address object is used for billing, shipping, and physical store address use cases.
  - `company` string — The company name associated with this address.
  - `country` string — The name of the country associated with this address.
  - `country_code` string, required — The ISO 3166-1 alpha-2 country code associated with this address.
  - `default` boolean — Set this to true to make this the default shipping address. There can be only one address with default set to true.
  - `door_code` string, nullable — The building door code or community gate code.
  - `email` string, email, required — An email address.
  - `first_name` string, required — The given name of the person associated with this address.
  - `last_name` string, required — The surname of the person associated with this address.
  - `locality` string, required — The city name details associated with this address.
  - `name` string — The given and surname of the person associated with this address.
  - `phone` string — A phone number following E164 standards, in its globalized format, i.e. prepended with a plus sign.
  - `postal_code` string, required — The the postal or zip code associated with this address.
  - `region` string, required — **Not Required for NON US addresses**. The region details such as state or province associated with this address.
  - `region_code` string, nullable — The ISO 3166-2 region code associated with this address. - * If specified, value must be valid for the `country`. - * If null, value is inferred from the `region`.
  - `street_address1` string, required — The street number and street name of the address.
  - `street_address2` string — Any apartment, floor, or unit details.
  - `street_address3` string, nullable — Any additional street address details.
  - `street_address4` string, nullable — Any additional street address details.
  - `metadata` ShopperMetadata, nullable — A key-value pair object that allows users to store arbitrary information associated with an object. For any individual account object, we allow up to 50 keys. Keys can be up to 40 characters long and values can be up to 500 characters long. Metadata should not contain any sensitive customer information, like PII (Personally Identifiable Information). For more information about metadata, see our [documentation](https://help.boltapp.com/developers/references/embedded-metadata/).
    - `additionalProperties` string

## Response `200`

Address Updated Successfully

- object — The address object returned in the response.
  - `company` string — The company name associated with this address.
  - `country` string — The name of the country associated with this address.
  - `country_code` string — The ISO 3166-1 alpha-2 country code associated with this address.
  - `door_code` string, nullable — The building door code or community gate code.
  - `email_address` string, email — An email address.
  - `first_name` string — The given name of the person associated with this address.
  - `id` string — The unique Bolt ID associated with this address.
  - `last_name` string — The surname of the person associated with this address.
  - `locality` string — The city name details associated with this address.
  - `name` string — The given and surname of the person associated with this address.
  - `phone_number` string — A phone number following E164 standards, in its globalized format, i.e. prepended with a plus sign.
  - `postal_code` string — The postal or zip code associated with this address.
  - `priority` 'primary' | 'listed', nullable — The shopper-indicated priority of this address compared to other addresses on their account.
  - `region` string — The region details such as state or province associated with this address.
  - `region_code` string, nullable — The the ISO 3166-2 region code associated with this address.
  - `street_address1` string — The street number and street name of the address.
  - `street_address2` string — Any apartment, floor, or unit details.
  - `street_address3` string, nullable — Any additional street address details.
  - `street_address4` string, nullable — Any additional street address details.
  - `metadata` ShopperMetadata, nullable — A key-value pair object that allows users to store arbitrary information associated with an object. For any individual account object, we allow up to 50 keys. Keys can be up to 40 characters long and values can be up to 500 characters long. Metadata should not contain any sensitive customer information, like PII (Personally Identifiable Information). For more information about metadata, see our [documentation](https://help.boltapp.com/developers/references/embedded-metadata/).
    - `additionalProperties` string
  - `default` boolean

---

[API](https://skmtc.dev/bolt/apis/bolt-api-reference.md) · [All operations](https://skmtc.dev/bolt/apis/bolt-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/bolt/bolt-api-reference/revisions/1f62c40558c6/schema)