---
title: "Update a user address"
method: PATCH
path: "/profiles/{userId}/address"
tags: ["User Profiles"]
---

# Update a user address

`PATCH /profiles/{userId}/address`

Update a user address, supplying one or more key/value pairs to to change.

## Path parameters

- `userId` string, required

## Request body

- Address — The address of the user.
  - `country` string, ISO ALPHA-2 — Two-letter country codes are used to represent countries and states
  - `name_line` string — The full name of the user
  - `premise` string — Premise (i.e. Apt, Suite, Bldg.)
  - `sub_premise` string — Sub Premise (i.e. Suite, Apartment, Floor, Unknown.
  - `thoroughfare` string — The address of the user
  - `administrative_area` string, ISO ALPHA-2 — The administrative area of the user address
  - `sub_administrative_area` string — The sub-administrative area of the user address
  - `locality` string — The locality of the user address
  - `dependent_locality` string — The dependant_locality area of the user address
  - `postal_code` string — The postal code area of the user address

## Response `200`

A user Address object extended with field metadata.

- object — Information about fields required to express an address.
  - `country` string, ISO ALPHA-2 — Two-letter country codes are used to represent countries and states
  - `name_line` string — The full name of the user
  - `premise` string — Premise (i.e. Apt, Suite, Bldg.)
  - `sub_premise` string — Sub Premise (i.e. Suite, Apartment, Floor, Unknown.
  - `thoroughfare` string — The address of the user
  - `administrative_area` string, ISO ALPHA-2 — The administrative area of the user address
  - `sub_administrative_area` string — The sub-administrative area of the user address
  - `locality` string — The locality of the user address
  - `dependent_locality` string — The dependant_locality area of the user address
  - `postal_code` string — The postal code area of the user address
  - `metadata` object — Address field metadata.
    - `required_fields` string[] — Fields required to express the address.
    - `field_labels` object — Localized labels for address fields.
    - `show_vat` boolean — Whether this country supports a VAT number.

---

[API](https://skmtc.net/upsun/apis/upsun-com-rest-api.md) · [All operations](https://skmtc.net/upsun/apis/upsun-com-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/upsun/upsun-com-rest-api/revisions/6cc88fde6435/schema)