Contact Model

Schema

{
  "attributes": {
    "email": "swebel@drift.com",
    "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 Name
Description
Description

id

int

The Drift identifier for the contact. This is will always be numeric.

createdAt

long

A unix timestamp for when the Contact was first captured.

attributes

JSON

A 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.

Field
Type
Description

name

String

The name of the Contact

email

String

The email of the Contact

phone

String

The phone number associated with the Contact

tags

List of ContactTags

A list of all tags associated with the contact

events

JSON

A map of Drift events associates with the contact.

socialProfiles

JSON

A map of social profile information enriched for the contact.

Contact Model