Update a Drawer (sidedrawer)

put

https://api-sbx.sidedrawersbx.com/api/v1/records/sidedrawer/sidedrawer-id/{sidedrawerId}

Allows the following attributes of a Drawer (sidedrawer) to be updated: Drawer (sidedrawer) name profile photoUser's first nameUser's email usernameUser's last namewhether it is the default Drawer (sidedrawer)whether notifications are enabled or disabledlicense keymetadatadata storage regionexternal keys

Path Params

sidedrawerId

string

required

Drawer (sidedrawer) identifier.

Body Params

name

string

Drawer (sidedrawer) name.

profilePhoto

string

Profile photo URL.

firstName

string

Drawer (sidedrawer) owner's first name.

emailUsername

string

Email username.

lastName

string

Drawer (sidedrawer) owner's last name.

default

boolean

This is the Account's default Drawer (sidedrawer).

notificationsDisabled

boolean

Set notificationsDisabled = true if notifications should be disabled.

licenseKey

string

License key.

brandCode

string

The affiliate code (brandCode) is an identifier for the "brand" or "affiliate" within a Tenant. The affiliate code is the version of the brand name that appears in the URL. A brand name may be "Corporate ABC", for example. Then the affiliate code might be something like "corporate-abc".

metadata

object

Additional key-value data. We recommend the use of ExternalKeys over this parameter as it is more flexible.

dataBaseRegion

string

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

externalKeys

array of objects

Key-value pairs.

externalKeys

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 Drawer (sidedrawer) has been successfully updated.