Create a Drawer (sidedrawer) Template

post https://api-sbx.sidedrawersbx.com/api/v1/tenants/tenant/tenant-id/{tenantId}/templates

Creates a Template Drawer (sidedrawer) for a Tenant. Use this endpoint to create a Drawer (sidedrawer) as normal, specifying the owner, Drawer name, region, etc. The use of this endpoint sets the boolean flag isTemplate = true so that the Drawer can be used as a Template elsewhere.

Path Params

tenantId

string

required

Unique Tenant identifier.

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

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

region

string

Region to store the Data (US, CA, EU)

public

boolean

Defaults to false

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

notificationsDisabled

boolean

required

Defaults to true

Set notificationsDisabled = true if notifications should be disabled.

Response

200

Successfully created a Template.

Language

Credentials

Bearer

JWT


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api-sbx.sidedrawersbx.com/api/v1/tenants/tenant/tenant-id/tenantId/templates \
3
     --header 'content-type: application/json' \
4
     --data '
5
{
6
  "public": false,
7
  "notificationsDisabled": true
8
}
9
'

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