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.

Person Object

Field Guide

The person object is a subset of the data representing a Customer, User or Team. The 'type' property will specify if this person is represented by a 'user', customer' or 'team'.

Name Type Example Notes
id Int 1234 Unique identifier
firstName String Jack First name of the person. Must be shorter than 40 characters
lastName String Sprout Last name of the person. Must be shorter than 40 characters
email String jack.sprout@gmail.com  
phone String 800-555-1212 Phone is only populated when the Person is a customer associated with a Conversation of type 'phone' and a phone number was specified at the time the conversation was created.
type String user The type of person.
  • user
  • customer
  • team
photoUrl String http://www.somesite.com/images/avatar.jpg The user's photo, if one exists

Example

{
    "id": 1234,
    "firstName": "Jack",
    "lastName": "Sprout",
    "email": "jack.sprout@gmail.com",
    "phone": "800-555-1212",
    "type": "user"
    "photoUrl": "http://www.somesite.com/images/avatar.jpg",
}
↑Back to top
© Help Scout 2024