Skip to main content

Set a user's address by type

PUT 

/api/users/:userId/addresses/:type

Requires admin token. Creates or fully replaces the user's address of the given type. Fields left out are cleared. state is required. Supported types: policy.

Request​

Path Parameters

    userId stringrequired
    type stringrequired

    Address type

    Example: policy

Body

required

    addressLine1 string

    Street Address

    addressLine2 string
    city string

    City

    state stringrequired

    2 Letter State Code (eg. AL, CA, CO etc.

    country string

    2 Letter Country Code. Must be US.

    zip string

    Zipcode

Responses​

The saved address.

Schema

    addressLine1 string

    Street Address Line 1

    addressLine2 string

    Street Address Line 2

    city string

    City

    state string

    2 Letter State Code

    country string

    2 Letter Country Code

    zip string

    Zip

Loading...