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.

Tag Object

Field Guide

The following fields are returned when listing tags.

Name Type Example Notes
id Int 1234 Unique identifier
slug String my-tag Slugified version of the tag value
name String My Tag The tag value
count Number 3 The number of times the tag is used
color String red The tag color
createdAt Datetime 2012-07-23T12:34:12Z UTC time when this tag was created.
modifiedAt Datetime 2012-07-24T20:18:33Z UTC time when this tag was modified.

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,
    "slug": "my-tag",
    "name": "My Tag",
    "count": 4,
    "color": "red",
    "createdAt": "2012-07-23T12:34:12Z",
    "modifiedAt": "2012-07-24T20:18:33Z"
}
↑Back to top
© Help Scout 2024