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.
|assignedTo||Person||The Help Scout user assigned to this conversation.|
|status||String||active||Status of the thread. Possible values include:
|createdAt||Datetime||2012-07-23T12:34:12Z||UTC time when this thread was created.|
|openedAt||Datetime||2012-07-23T03:22:32Z||UTC time when this thread was viewed by the customer. Only applies to threads with a 'type' of message.|
|createdBy||Person||The Person who created this thread. The 'type' property will specify whether it was created by a 'user' or a 'customer'.|
Describes an optional action associated with the line item. Possible values are:
Associated with the 'actionType' property.
|fromMailbox||MailboxRef||If the conversation was moved, fromMailbox represents the MailboxRef from which it was moved.|
|type||String||message||The type of thread. Possible values include:
When a conversation is forwarded, a new conversation is created to represent the forwarded conversation.
forwardparent is the type set on the thread of the original conversation that initiated the forward event.
forwardchild is the type set on the first thread of the new forwarded conversation.
|state||String||published||The state of the thread. Possible values include:
A state of underreview means the thread has been stopped by Collisino Detection and is waiting to be confirmed (or discarded) by the person that created the thread.
A state of hidden means the thread was hidden (or removed) from customer-facing emails.
|customer||Person||If thread type is message, this is the customer associated with the conversation. If thread type is customer, this is the the customer who initiated the thread.|
|body||String||This is what I have to say. Thank you.|
|to||Collection||Collection of Strings representing email addresses.|
|cc||Collection||Collection of Strings representing email addresses.|
|bcc||Collection||Collection of Strings representing email addresses.|
|attachments||Collection||Collection of Attachment objects, if attachments exist.|
|savedReplyId||Int||123||ID of Saved reply that was used to create this Thread|