Create an Account

post

https://api-sbx.sidedrawersbx.com/api/v1/users/accounts

Creates an Account. Use the request body to set such parameters as: username, name, date of birth, primary residence, emails, phone numbers.

Body Params

username

string

Account username. Default: the Auth0 username.

firstName

string

Account first name. Default: the Auth0 first name.

lastName

string

Account last name. Default: the Auth0 last name.

profilePhoto

string

Profile photo URL.

dateOfBirth

string

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

Gender.

Allowed:

emails

array of objects

Account emails. Default: the Auth0 email.

emails

phones

array of objects

required

Account phone number(s).

phones*

settings

object

required

Account settings information.

agreements

array of objects

required

An Agreements object. These are agreements that must be accepted when a SideDrawer Account is created. Newer versions may also be sent out when required. There are three agreement types: terms of service (tos), privacy policies (privacy_policies), and anti-spam (anti_spam).

agreements*

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.

identityProvider

string

enum

Identity provider used when the Account is created. Default: auth0.

Allowed:

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

201Successfully created the Account.