API Reference
Log In
API Reference

Templates

Templates are Drawers (sidedrawer) that can be used as the basis for another Drawer. For example, if you have clients for whom you are creating a Drawer each, you will likely want all of these to have the same setup.

You can create your Template (or set an existing Drawer to be a Template) with the Hangers (recordType), Folders (record), and files (recordFile) you will want your clients to have. The collaboration networks you set up will also be carried over to the Drawers you create for your clients, as will Info Requests in the Drawer.


{
  "name": "My Drawer template",
  "type": "individual",
  "typeOtherName": "",
  "selfOwned": true,
  "owner": {
    "firstName": "Jane",
    "lastName": "Smith",
    "email": "jane.smith@emailcom",
    "phone": "4161234567",
    "brandCode": "mybrand"
  },
  "coOwners": [
    {
      "firstName": "",
      "lastName": "",
      "email": "",
      "phone": "",
      "brandCode": ""
    }
  ],
  "brandCode": "mybrand",
  "region": "CA",
  "public": false,
  "notificationsDisabled": true
}

Template entity

name string required
Drawer name.


type string
Drawer type. Default: individual.


typeOtherName string
Drawer type if type = other.


owner Contributor entity
Owner information if the owner is not the user currently logged in.


coOwners array of Contributor entities
Co-owner information.


brandCode string
Branding code.


region string
Data storage region. Possible values: "US", "CA", "EU".


public boolean
True if the Template should be public. Default: false.


notificationsDisabled boolean required
True if notifications should be disabled. Default: true.



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