Update an Account's settings

put

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

Updates Account settings for a given Account identifier. Use the request body to modify settings parameters such as: notificationMethod``communicationLanguage``preferredLanguage``country``mfaDisabled``notificationsDisabled``mfaMode``idpMfa``currency

Path Params

accountId

string

required

Unique Account identifier.

Body Params

notificationMethod

string

enum

required

Preferred communication method.

Allowed:

communicationLanguage

string

enum

required

Preferred communication language.

Allowed:

preferredLanguage

string

enum

required

Preferred language.

Allowed:

country

string

enum

required

Address country in ISO 3166 format (ex. "CA" or "US").

mfaDisabled

boolean

required

Set mfaDisabled = true if multi-factor authentication should be disabled.

notificationsDisabled

boolean

required

Set notificationsDisabled = true if notifications should be disabled.

mfaMode

string

enum

required

Multi-factor authentication (MFA) mode.

Allowed:

idpMfa

string

enum

required

Identity provider multi-factor authentication (MFA) mode.

Allowed:

currency

string

required

The currency in which to operate. For example, "cad" or "usd".

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 the Account settings.