Mailbox Folder Object

Field Guide

Name Type Example Notes
id Int 1234 Unique identifier
name String My Tickets Folder name
type String mytickets The type this folder represents. Possible options include:
  • unassigned
  • mytickets
  • needsattention
  • drafts
  • assigned
  • closed
  • spam
userId Int 4532 If the folder type is MyTickets, userId represents the Help Scout user to which this folder belongs. Otherwise userId is zero
totalCount Int 2 Total number of conversations in this folder
activeCount Int 1 Total number of conversations in this folder that are in an active state (vs pending).
modifiedAt Datetime 2012-07-24T20:18:33Z UTC time when this folder was modified.

Example

{	
    "id": 1234,
    "name": "My Tickets",
    "type": "mytickets",
    "userId": 4532,
    "totalCount": 2,
    "activeCount": 1,
    "modifiedAt": "2012-07-24T20:18:33Z"
}