Create Sidedrawer from Subscription

post

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

Creates a Drawer (sidedrawer) from a Subscription.

Path Params

tenantId

string

required

Tenant identifier.

subscriptionId

string

required

Subscription identifier.

Body Params

name

string

required

Drawer (sidedrawer) name.

emailUsername

string

Email username.

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

object

If the Owner is not the logged-in user, enter the Owner information here.

coOwners

array of objects

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

dataBaseRegion

string

This is the region in which the data should be stored. Possible values: US, Canada, 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

Additional key-value data.

externalKeys

notificationsDisabled

boolean

Set notificationsDisabled = true if notifications should be disabled.