Create a Drawer (sidedrawer) from a Subscription

post https://api-sbx.sidedrawersbx.com/api/v2/tenants/tenant/tenant-id/{tenantId}/subscriptions/subscription-id/{subscriptionId}/sidedrawer

Creates a sponsored Drawer (sidedrawer) from a Subscription, assuming an Invitation code has already been sent or the desired owner has an OpenID.

Path Params

tenantId

string

required

Unique Tenant identifier.

subscriptionId

string

required

Subscription ID

Body Params

name

string

required

Drawer (sidedrawer) Name

type

string

Drawer (sidedrawer) type (Individual as default)

typeOtherName

string

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

selfOwned

boolean

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

owner

string

Owner OpenID.

coOwners

array of strings

Co-owner(s) OpenID.

coOwners

brandCode

string

Affiliate code (brandCode).

licenseKey

string

License key.

dataBaseRegion

string

Region in which to store the data. Possible values: "US", "CA", "EU".

metadata

object

Metadata key-value pairs.

skipSponsorEditorAssignment

boolean

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

externalKeys

array of objects

External key-value pairs.

externalKeys

public

boolean

Defaults to false

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

notificationsDisabled

boolean

Set notificationsDisabled = true if notifications should be disabled.

invitationCode

string

The Invitation code to the entity.

federationId

string

Unique federation identifier.

Response

200

Successfully created a Drawer.

Language

Credentials

Bearer

JWT


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api-sbx.sidedrawersbx.com/api/v2/tenants/tenant/tenant-id/tenantId/subscriptions/subscription-id/subscriptionId/sidedrawer \
3
     --header 'content-type: application/json' \
4
     --data '{"public":false}'

Click Try It! to start a request and see the response here!