Create a Drawer (sidedrawer) from a Subscription (sends Invitation where applicable)

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

Creates a sponsored Drawer (sidedrawer) from a Subscription. If the owner is not an existing User, this endpoint also sends an Invitation.

Path Params

tenantId

string

required

Unique Tenant identifier.

subscriptionId

string

required

Subscription ID

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

Owner information if the owner is not the User currently logged in.

coOwners

array of objects

Co-owner(s) information.

coOwners

brandCode

string

Affiliate code (brandCode).

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

notificationsDisabled

boolean

Set notificationsDisabled = true if notifications should be disabled.

Response

200

Successfully created a Drawer.

Language

Credentials

Bearer

JWT


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api-sbx.sidedrawersbx.com/api/v1/tenants/tenant/tenant-id/tenantId/subscriptions/subscription-id/subscriptionId/sidedrawer \
3
     --header 'content-type: application/json'

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