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.

Rating Object

Field Guide

The following fields are returned when a Satisfaction Rating event is received via webhooks.

Name Type Example Notes
id Int 29418 Unique identifier
customer Object   Partial customer object
ticketId Int 15600  
threadId Int 3002084  
mailbox MailboxRef   MailboxRef to which this conversation belongs.
rating String Great Options: Great, Okay, Bad
comments String he was really helpful  
createdAt Datetime 2015-04-13T12:34:12Z UTC time when this rating was created.
modifiedAt Datetime 2015-04-14T20:18:33Z UTC time when this rating was modified.

Example

{
    "id":5434,
    "customer":{
        "id":449379,
        "firstName":"John",
        "lastName":"Doe",
        "emails":[
            {
                "id":1220012,
                "value":"john.doe@gmail.com",
                "location":"work"
            }, {
                "id":1220013,
                "value":"john.doe@example.com",
                "location":"work"
            }
        ]
    },
    "ticketId":1560011,
    "threadId":3002084,
    "mailbox": {
        "id": 1234,
        "name": "My Mailbox"
    },
    "rating":"Great",
    "comments":"he was really helpful",
    "createdAt": "2015-04-13T12:34:12Z",
    "modifiedAt": "2015-04-14T20:18:33Z"
}
↑Back to top
© Help Scout 2024