Create Address

post

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

This API requires the Account Administrator role.

Creates an address for a user.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

accountId

string

required

length between 6 and 6

^[a-zA-Z]{6}$

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

userId

string

required

length between 36 and 36

^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

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

Body Params

User address payload

A real address for an user.

addressName

string

required

length between 2 and 32

^[a-zA-Z\p{L}0-9]+([ ]*[a-zA-Z\p{L}0-9-\_\*\=\+\$\:\;\&\~\,\?\%\!\|\{\}\`\.\']+)*$

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

^[A-Za-z]{2,3}$

zip

string

required

length between 4 and 16

^[A-Za-z0-9\p{L}_ -]*$

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

Bearer

JWT

URL

Loading…

Response

Choose an example:

application/json

application/problem+json

202Accepted

400Constraint Violation

401Unauthorized

403Forbidden

404Not Found

500Request processing failed