API Reference
Log In
API Reference

Drawers

A Drawer (sidedrawer) is the main entity of a User or Tenant's account, within which Hangers (recordType), Folders (record) and files (recordFile) may be sorted.

Once created, a Drawer can be accessed through API calls using its sidedrawerId.

More info about the organization of entities here.


{
  "name": "Personal Drawer",
  "emailUsername": "{username}",
  "type": "individual",
  "typeOtherName": "",
  "selfOwned": true,
  "owner": {
    "firstName": "Jane",
    "lastName": "Smith",
    "email": "[email protected]",
    "phone": "4161234567"
  },
  "coOwners": [
    {
      "firstName": "John",
      "lastName": "Smith",
      "email": "[email protected]",
      "phone": ""
    }
  ],
  "brandCode": "{brandCode}",
  "licenseKey": "",
  "dataBaseRegion": "CA",
  "metadata": {},
  "skipSponsorEditorAssignment": true,
  "externalKeys": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "public": false,
  "notificationsDisabled": true
}

Drawer (sidedrawer) entity

name string required
Drawer (sidedrawer) name.

emailUsername string
Email username.

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 Contributor entity
Owner information if selfOwned = false.

coOwners array of Contributor entities
Co-owner(s) information.

brandCode string
Affiliate code (brandCode).

licenseKey string
License key.

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

metadata Metadata entity
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 External Key entities
External key-value pairs.

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

notificationsDisabled boolean
Set notificationsDisabled = true if notifications should be disabled.


Contributor (contributor) entity

firstName string
Contributor's first name.

lastName string
Contributor's last name.

email string required
Contributor's email address.

phone string
Contributor's phone number.