latestOpenAPI 3.0.12026-08-10234260964.0 KB

6cc88fde6435

User Profiles

Update a user address

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

patch/profiles/{userId}/address

Path parameters

userIdstring required

The UUID of the user

Request body

countrystring ISO ALPHA-2

Two-letter country codes are used to represent countries and states

name_linestring

The full name of the user

premisestring

Premise (i.e. Apt, Suite, Bldg.)

sub_premisestring

Sub Premise (i.e. Suite, Apartment, Floor, Unknown.

thoroughfarestring

The address of the user

administrative_areastring ISO ALPHA-2

The administrative area of the user address

sub_administrative_areastring

The sub-administrative area of the user address

localitystring

The locality of the user address

dependent_localitystring

The dependant_locality area of the user address

postal_codestring

The postal code area of the user address

Response

A user Address object extended with field metadata.

countrystring ISO ALPHA-2

Two-letter country codes are used to represent countries and states

name_linestring

The full name of the user

premisestring

Premise (i.e. Apt, Suite, Bldg.)

sub_premisestring

Sub Premise (i.e. Suite, Apartment, Floor, Unknown.

thoroughfarestring

The address of the user

administrative_areastring ISO ALPHA-2

The administrative area of the user address

sub_administrative_areastring

The sub-administrative area of the user address

localitystring

The locality of the user address

dependent_localitystring

The dependant_locality area of the user address

postal_codestring

The postal code area of the user address