Create a Drawer (sidedrawer) from a Subscription

post

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

Creates a Drawer (sidedrawer) from a Subscription. Specify the Subscription identifier (subscriptionId) in the path and Drawer (sidedrawer) information in the request body.

Path Params

subscriptionId

string

required

Unique Subscription identifier.

Body Params

name

string

required

Drawer (sidedrawer) name.

type

string

Drawer (sidedrawer) type. Default: individual.

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. OpenID is an open standard authentication method used as identification for Users, like a username or email might be used.

coOwners

array of strings

Co-owner(s) OpenID. OpenID is an open standard authentication method used as identification for Users, like a username or email might be used.

coOwners

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

licenseKey

string

License key.

dataBaseRegion

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.

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

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

Invitation code.

federationId

string

This is only applicable for enterprise implementations. The federationId identifies the institution.

Response

200

Successfully created a Drawer (sidedrawer).