Update Address

put

{protocol}://{server}:{port}{basePath}/accounts/{accountId}/users/{userId}/addresses/{addressId}

This API requires the Account Administrator role.

Updates an address of a user.

This operation will clear the value stored for any fields not present in the request.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

accountId

string

required

length between 6 and 6

The unique 6 character internal id that represents the customer account.

userId

string

required

length between 36 and 36

The unique 36 character internal id (uuid) that represents the user.

addressId

string

required

length between 36 and 36

The unique 36 character internal id (uuid) that represents the address.

Body Params

User address payload

A real address for an user.

addressName

string

required

length between 2 and 32

addressType

string | null

enum

It is to narrow down the exact dispatched location for the agent/user

addressTypeNumber

string

length between 0 and 64

It is optional unless the AddressType is specified and it can be used for things like "Floor 1" or "Unit 101".

streetNumber

string

required

length between 1 and 16

streetName

string

required

length between 2 and 128

city

string

length between 0 and 128

state

string

length between 1 and 3

countryCode

string

required

length between 2 and 3

zip

string

required

length between 4 and 16

isDefault

boolean

Defaults to false

Indicated default address of user

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

URL

Loading…

Response

Choose an example:

application/json

application/problem+json

202Accepted

400Constraint Violation

401Unauthorized

403Forbidden

404Not Found

500Request processing failed