User Model

You will see different user types in the User API's described in this section. The word "User" is used to describe internal agents to your organization or account - while site visitors or contacts are those that are interacting from your website.

The schema for User objects is as follows:

User Schema

{
  "id": int,
  "orgId": int,
  "name": string,
  "alias": string,
  "email": string,
  "phone": string,
  "locale": string,
  "availability": string,
  "role": string,
  "timeZone": string,
  "avatarUrl": string,
  "verified": boolean,
  "bot": boolean,
  "createdAt": long,
  "updatedAt": long
}

Top Level User Field Explanation

These attributes will be present on the model or absent if the value has not been set.

Field Name

Description

Description

id

int

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

createdAt

long

A unix timestamp for when the contact was first captured.

name

string

The name of the user

alias

string

The short hand name for the user (if present)

email

string

The email of the user

phone

string

The phone number associated with the user

locale

string

The locale for the user

availability

string

Description of user's current state: one of "AVAILABLE", "OFFLINE", "ON_CALL".

role

string

Role of Drift user: one of "member", "admin", "agent"

timeZone

string

Timezone for the user represented as a string (if known)

avatarUrl

string

The url for the user's avatar (profile) image

verified

boolean

Is the user account verified? i.e. belongs to an actual person / not manually created?

bot

boolean

Is the user a bot user?

createdAt

long

Timestamp (milliseconds) representing when the user was created

updatedAt

long

timestamp (milliseconds) representing when the user was last updated

📘

Users can't be deleted or created via the API

Such actions would potentially affect billing and are not currently supported.

Updated 3 months ago


User Model


Suggested Edits are limited on API Reference Pages

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