Account Model
Accounts are used in Drift's paid plans, and can be queried/modified using the endpoints described in this section. Accounts can be used for ABM (account based marketing) in Drift, and can be tied to the display conditions of particular playbooks - enabling account specific marketing strategies.
Updating, creating, or deleting accounts will require the account_write
scope.
Accessing, searching, or getting accounts requires the account_read
scope.
Schema
{
"data": {
"ownerId": 21965, // Drift owner id (required). Often mapped from Salesforce or other CRM
"name": "Company Name",
"domain": "www.domain.com",
"accountId": "123458_domain.com",
"customProperties": [
{
"label": "My Number", // human readable label of property
"name": " my number", // name of property
"value": 1, // custom property value
"type": "NUMBER" // type of custom property
}
],
"deleted": false,
"createDateTime": 1531159572668, // timestamp when the account was created
"updateDateTime": 1533243683493, // last updated timestamp of the account
"targeted": true
}
}
Field Definitions
Field | Type | Description |
---|---|---|
ownerId | int | The ID of the owner in Drift (should be a known user ID) |
name | string | The name of the company |
domain | string | The domain of the company |
accountId | string | Identifier for the company (used for lookup) |
customProperties | list[Custom Property] | List of custom properties associated with the account. |
deleted | boolean | Is the account deleted (deleted accounts won't be visible in drift, but are retrievable by id for auditing). |
createDateTime | long | The timestamp creation time of the account |
updateDateTime | long | The timestamp last updated time of the account |
targeted | boolean | Is the account currently targeted |
Custom Properties
Field | Type | Description |
---|---|---|
label | string | The readable name of the property |
name | string | The internal name of the property |
value | Type (type) | The value of the propertty |
type | string | Data type of the property. One of {STRING, EMAIL, NUMBER, TEAMMEMBER, ENUM, DATE, DATETIME, LATLON, LAT, LON, PHONE, URL, ENUMARRAY} |
Note About Account to Contact Relationships in Drift
Because Drift works to deanonymize visitors through IP address, Contacts are related to Accounts through email and website domain. All Accounts have a unique ID composed of the customer's Drift OrgId and the Account Domain. For example, if the OrgId is 5002142 and the Account has a domain of https://www.drift.com, the Account Id will be 5002142_drift.com. This makes Account Id guessable for Contacts in Drift on the basis of their email.
Updated almost 2 years ago