API Reference
Log In
API Reference

Hangers

A Hanger (recordType) is a section of a Drawer (sidedrawer). For example, within a Drawer, you may have a Hanger for Tax Documents and another Hanger for Legal documents.

Within a Hanger, Folders (record) can be created, and these can contain files (recordFile).

More info about the organization of entities here.


[
  {
    "id": "{hangerId}",
    "name": "legalFiles",
    "logo": "",
    "sidedrawerType": "individual",
    "sidedrawerTypeOtherName": "",
    "displayValue": [
      {
        "locale": "en-CA",
        "value": "Legal Documents",
        "description": ""
      }
    ],
    "cobrandId": "{cobrandId}",
    "orderId": 0
  }
]

Hanger (recordType) entity

id string required
Unique Hanger (recordType) identifier.

name string required
Hanger (recordType) name.

logo string required
URL of the logo to display for the Hanger.

sidedrawerType string
Drawer (sidedrawer) type.
Default: individual.

sidedrawerTypeOtherName string
Drawer (sidedrawer) type if sidedrawerType = "other".

displayValue array of Display Value entities required
List of values to display, depending on the language.

cobrandId string
Unique cobrand identifier.

orderId number
Number of the position of this Hanger (recordType) when the Hangers are sorted in a list.


Display Value (displayValue) entity

locale enum required
Locale.
Possible values: en-CA, fr-CA, en-US, es-US.

value string required
Value of display.

description string
Description.