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.

Abbreviated Conversation Object

Field Guide

The following fields are returned when listing abbreviated conversations.

Name Type Notes
id Int Unique identifier of the conversation
number Int The conversation number displayed in the UI. This number can be used in combination with the id to construct a URL to the conversation on the Help Scout website. Example: https://secure.helpscout.net/conversation/<id>/<number>/
type String The type of conversation; possible values include:
  • email
  • chat
  • phone
mailboxId Int Identifier of the mailbox in which this conversation resides
attachments Boolean Indicates whether this conversation has attachments
subject String  
status String Status of the conversation; possible values include:
  • active
  • pending
  • closed
  • spam
threadCount Int The number of published threads found on the conversation (does not include line items, drafts or threads held for review by Collision Detection.)
preview String  
customerName String The customer who this conversation is associated with
customerEmail String The customer email address who this conversation is associated with
customerIds Collection of Int The customer identifiers this conversation is associated with
modifiedAt Date/Time The date/time this conversation was last modified (ISO 8601, in UTC)
assignedid Int The identifier of the user assigned to this conversation
tags Collection Collection of tags with each element containing the tag identifier, name, and color
assignedName String The name of the user assigned to this conversation

Example

{
  "id": 583,
  "number": 12345,
  "type": "email",
  "mailboxid": 2,
  "attachments": false,
  "subject": "Sample subject",
  "status": "active",
  "threadCount": 6,
  "preview": "This is a preview...",
  "customerName": "John Smith",
  "customerEmail": "john@example.com",
  "customerIds": [
    2
  ],
  "modifiedAt": "2015-04-24T18:59:49Z",
  "assignedid": 4,
  "tags": [
    {
      "id": 123,
      "name": "sample-tag",
      "color": "none"
    }
  ],
  "assignedName": "Mary Jones"
}
↑Back to top
© Help Scout 2024