Update an Account

put

https://api-sbx.sidedrawersbx.com/api/v1/users/accounts/account-id/{accountId}

Updates Account information (including username, name, primary residence, emails, phone numbers) using the request body.

Path Params

accountId

string

required

Unique Account identifier.

Body Params

username

string

required

Account username.

firstName

string

required

Account first name.

lastName

string

required

Account last name.

profilePhoto

string

Profile photo URL.

dateOfBirth

date-time

Date of birth (DD/MM/YYYY).

maritalStatus

string

enum

Marital status.

Allowed:

brandCodeAffiliations

array of strings

Affiliations of the affiliate code (brandCode).

brandCodeAffiliations

primaryResidence

object

Primary residence address.

gender

string

enum

Account User's gender. Possible values: female, male, rather_not_say, other.

Allowed:

emails

array of objects

required

Account email address(es).

emails*

phones

array of objects

required

Account phone number(s).

phones*

invitationCode

string

Invitation code.

referralCode

string

Invitation code sent from a referral, business or sponsor.

defaultSidedrawer

string

Default Drawer (sidedrawer) identifier.

dataBaseRegion

string

This is the region in which the data should be stored. Possible values: US, CA, EU.

Response

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successfully updated an Account.