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.

Customer Address Object

Field Guide

Name Type Example Notes
id Int 1234 Unique identifier
lines Collection (String)    
city String Dallas  
state String TX  
postalCode String 74206  
country String US  
createdAt Datetime 2012-07-23T12:34:12Z UTC time when this address was created.
modifiedAt Datetime 2012-07-24T20:18:33Z UTC time when this address was modified.

Example

{
    "id": 1234,
    "lines": [
        "123 West Main St",
        "Suite 123"
    ],
    "city": "Dallas",
    "state": "TX",
    "postalCode": "74206",
    "country": "US",
    "createdAt": "2012-07-23T12:34:12Z"
    "modifiedAt": "2012-07-24T20:18:33Z"
}
↑Back to top
© Help Scout 2025