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.

SearchConversation Object

Field Guide

The following fields are returned when listing Conversation search results.

Name Type Example Notes
id Int 2391938111 Unique identifier
number Int 349 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>/
mailboxid Int 85  
subject String I need help!  
status String active Status of the conversation. Possible values include:
  • active
  • pending
  • closed
  • spam
threadCount Int 4 This count represents the number of published threads found on the conversation (it does not include line items, drafts or threads held for review by Collision Detection).
preview String I need help... This represents the first 185 characters in the body of the most recent thread.
customerName String John Appleseed  
customerEmail String john@appleseed.com  
modifiedAt Datetime 2012-07-24T20:18:33Z UTC time when this conversation was modified.
hasAttachments Boolean true Flag that is true when the conversation has at least one attachment.

Example

{   
    "id": 2391938111,
    "number": "349",
    "mailboxid": 1234,
    "subject": "I need help!",
    "status": "active",
    "threadCount": 3,
    "preview": "Hello, I tried to download the file off your site...",
    "customerName": "John Appleseed",
    "customerEmail": "john@appleseed.com",
    "modifiedAt": "2012-07-24T20:18:33Z".
    "hasAttachments: true,
}
↑Back to top
© Help Scout 2024