API Reference

Create a Drawer (sidedrawer) for a free Subscription

post
https://api-sbx.sidedrawersbx.com/api/v1/records/sidedrawer

Creates a new Drawer (sidedrawer) for free.

Body Params
string
required

Drawer (sidedrawer) name.

string

Email username.

string

Drawer (sidedrawer) type. Default: individual.

string

Drawer (sidedrawer) type if sidedrawerType = "other".

boolean

selfOwned = true if the owner is the User currently logged in.

owner
object

Owner information if selfOwned = false.

coOwners
array of objects

Co-owner(s) information.

coOwners
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".

string

License key.

string

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

metadata
object

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

boolean

Set skipSponsorEditorAssignment = true if you do not want to allow Subscription owners to "auto-add" themselves as "sd_editor".

externalKeys
array of objects

Key-value pairs.

externalKeys
boolean
Defaults to false

public = true if the Drawer (sidedrawer) is public. Default: false.

boolean

Set notificationsDisabled = true if notifications should be disabled.

Response

Updated 11 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 months ago

Did this page help you?