Update account

put

https://tenants-gateway-api-sbx.sidedrawersbx.com/api/v1/tenants/tenant/tenant-id/{tenantId}/users/open-id/{openId}

Updates an account.

Path Params

tenantId

string

required

Tenant identifier.

openId

string

required

User who created the automation.

Body Params

federationId

string

This is only applicable for enterprise implementations. The federationId identifies the institution. This is optional in this case; just for a scenario in which you need to create a User that will be federated later by an enterprise SSO connection.

firstName

string

Account first name.

lastName

string

Account last name.

profilePhoto

string

URL of the profile photo.

dateOfBirth

date-time

Date of birth in DD/MM/YYYY format.

maritalStatus

string

enum

Marital status.

Allowed:

primaryResidence

object

Account User's primary residence address.

gender

string

enum

Account User's gender.

Allowed:

emails

array of objects

Account emails.

emails

phones

array of objects

Account phone number(s).

phones

agreements

array of objects

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

identityProvider

string

enum

Identity provider used. Default: Auth0.

Allowed:

brandCodeAffiliations

array of strings

Affiliations of the affiliate code (brandCode).

brandCodeAffiliations

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

201The Account has been successfully updated.