A lead object contains the following fields -
| Attribute | Type | Description |
|---|---|---|
| type | string | value is 'contact' This value is read only |
| id | string | The Intercom defined id representing the Lead This value is read only |
| created_at | timestamp | The time the Lead was added to Intercom This value is read only |
| updated_at | timestamp | The last time the Lead was updated This value is read only |
| user_id | string | Automatically generated identifier for the Lead |
| string | The email you have defined for the Lead | |
| phone | string | The phone number you have defined for the lead |
| name | string | The name of the Lead |
| custom_attributes | object | The custom attributes you have set on the Lead |
| last_request_at | timestamp | The time the Lead last recorded making a request |
| avatar | object | An avatar object for the Lead |
| unsubscribed_from_emails | boolean | Whether the Lead is unsubscribed from emails |
| location_data | object | A Location Object relating to the Lead To update location_data use last_seen_ip which will be translated to the appropriate location_data |
| user_agent_data | string | Data about the last user agent the Lead was seen using Update using last\_seen\_user\_agent |
| last_seen_ip | no | An ip address (e.g. "1.2.3.4") representing the last ip address the Lead visited your application from. (Used for updating location_data) |
| companies | list | A list of companies for the Lead |
| social_profiles | list | A list of social profiles associated with the Lead This value is read only |
| segments | list | A list of segments the Lead. |
| tags | list | A list of tags associated with the Lead. |
Information on social profile, avatar and location objects can be found under the Users documentation.