Legacy Mailbox API 1.0 is deprecated

Legacy Mailbox API 1.0 was deprecated on November 20, 2019. Please use Mailbox API 2.0 going forward. If you have any questions or need help with the new API, please reach out.

Mailbox Object

Field Guide

The following fields are returned when listing mailboxes.

Name Type Example Notes
id Int 1234 Unique identifier
name String My Mailbox Name of the Mailbox
slug String 47204a026903ce6d Key used to represent this Mailbox
email String help@mymailbox.com Email address
createdAt Datetime 2012-07-23T12:34:12Z UTC time when this mailbox was created.
modifiedAt Datetime 2012-07-24T20:18:33Z UTC time when this mailbox was modified.
customFields Collection   Collection of Custom Field objects; only included for Plus Plan accounts

Additional Fields

In addition to the fields above, the following fields are returned when retrieving a single Mailbox.

Name Type Example Notes
folders Collection   Collection of Folder objects.

Example

{	
    "id": 1234,
    "name": "My Mailbox",
    "slug": "47204a026903ce6d",
    "email": "help@mymailbox.com",
    "createdAt": "2012-07-23T12:34:12Z",
    "modifiedAt": "2012-07-24T20:18:33Z",
    "folders": [
        {
            "id": 1234,
            "name": "Mine",
            "type": "mine",
            "userId": 4532,
            "totalCount": 2,
            "activeCount": 1,
            "modifiedAt": "2012-07-24T20:18:33Z"
        },
        {... folder object ...}
    ]
}
↑Back to top
© Help Scout 2024