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": "722r2d22-beb9-4Zeb-9354-a0c3sd796044",
        "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}


Did this page help you?