Contact Model

Schema

{
  "attributes": {
    "email": "[email protected]",
    "events": {},
    "name": "Stephen Webel",
    "socialProfiles": {},
    "tags": [],
    "externalId": 12341243 (sometimes set by external integrations),
    ...
  },
  "createdAt": 1506971031434,
  "id": 349999553
}

Top Level Field Explanation

The top-level Contact object is intentionally simple, allowing for deep customization via attributes.

Field NameDescriptionDescription
idlong (int64)The Drift identifier for the contact. This will always be numeric. Should be treated as long or integer 64 bit data type.
createdAtlongA unix timestamp for when the Contact was first captured.
attributesJSONA map of all attributes associated with this Contact. Attributes will contain both Drift controlled data and Custom Attributes generated by an organization or a third-party app.

Contact Attributes Explanation

Attributes will contain a mix of Drift generate data as well as Custom Attributes. Custom Attributes are easily added by simply adding a key and a non-null value to the attribute map when either creating or updating a contact.

FieldTypeDescription
nameStringThe name of the Contact
emailStringThe email of the Contact
phoneStringThe phone number associated with the Contact
tagsList of ContactTagsA list of all tags associated with the contact
eventsJSONA map of Drift events associates with the contact.
socialProfilesJSONA map of social profile information enriched for the contact.

📘

Want to customize your data?

You aren't just limited to text and number fields. Find out about other data types here

Updated 11 months ago

Contact Model


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.