Customer Object
Field Guide
The following fields are returned when a Customer Created webhook is received.
Name | Type | Example | Notes |
---|---|---|---|
id | Int | 29418 | Unique identifier |
firstName | String | Vernon | |
lastName | String | Bear | |
photoUrl | String | http://twitter.com/img/some-avatar.jpg | |
photoType | String | Type of photo. Possible values include:
|
|
gender | String | Male | Gender of this customer. Possible values include:
|
age | String | 30-35 | |
organization | String | Acme, Inc | |
jobTitle | String | CEO and Co-Founder | |
location | String | Greater Dallas/FT Worth Area | |
createdAt | Datetime | 2012-07-23T12:34:12Z | UTC time when this customer was created. |
modifiedAt | Datetime | 2012-07-24T20:18:33Z | UTC time when this customer was modified. |
Additional Fields
In addition to the fields above, the following fields are returned when retrieving a single Customer.
Name | Type | Example | Notes |
---|---|---|---|
background | String | I've worked with Vernon before and he's really great. | This is the Notes field from the user interface. |
address | CustomerAddress | ||
socialProfiles | Collection | Collection of CustomerSocialProfile objects | |
emails | Collection | Collection of CustomerEmail objects | |
phones | Collection | Collection of CustomerPhone objects | |
chats | Collection | Collection of CustomerChat objects | |
websites | Collection | Collection of CustomerWebsite objects |
Example
{
"id": 29418,
"firstName": "Vernon",
"lastName": "Bear",
"photoUrl": "http://twitter.com/img/some-avatar.jpg",
"photoType": "twitter",
"gender": "Male",
"age": "30-35",
"organization": "Acme, Inc",
"jobTitle": "CEO and Co-Founder",
"location": "Greater Dallas/FT Worth Area",
"background": "I've worked with Vernon before and he's really great.",
"createdAt": "2012-07-23T12:34:12Z",
"modifiedAt": "2012-07-24T20:18:33Z",
"address": {
"id": 1234,
"lines": [
"123 West Main St",
"Suite 123"
],
"city": "Dallas",
"state": "TX",
"postcalCode": "74206",
"country": "US",
"createdAt": "2012-07-23T12:34:12Z"
"modifiedAt": "2012-07-24T20:18:33Z"
},
"socialProfiles": [
{
"id": 9184,
"value": "https://twitter.com/helpscout",
"type": "twitter"
},
{... social profile object ...}
],
"emails": [{
"id": 98131,
"value": "vbear@mywork.com",
"location": "work"
},
{... email object ...}
],
"phones": [{
"id": 22381,
"value": "222-333-4444",
"location": "home"
},
{... phone object ...}
],
"chats": [{
"id": 77183,
"value": "jsprout",
"type": "aim"
},
{... chat object ...}
],
"websites": [{
"id": 5584,
"value": "http://www.somewhere.com"
},
{... website object ...}
]
}