Meeting Model

You will see meetings in the Users API described in this section. A meeting object is used to describe booked meetings to your organization or account through conversations or team pages.

Each meeting includes the time slot of the event, the scheduler ID, contact ID, agent ID, and Drift user ID of the parties involved (amongst other metadata). Information on the schedulers can be obtained via the GET contact and GET users endpoints respectively.

The schema for meeting objects is as follows:

Meeting Schema

{
  "agentId": int,
  "orgId": int,
  "status": string,
  "meetingSource": string, 
  "schedulerId": long, 
  "eventId": string,
  "slug": string, 
  "slotStart": long (timestamp),
  "slotEnd": long (timestamp),
  "updatedAt": long (timestamp),
  "scheduledAt": long (timestamp),
  "meetingType": string,
  "conversationId:" long, 
  "endUserTimeZone:" string, 
  "meetingNotes:" string, 
  "bookedBy:" int
   
}

Top Level Meeting Fields Explanation

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

Field Name

Type

Description

agentId

int

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

orgId

int

Drift organization identifier. This will be always numeric.

status

string

ex:"ACTIVE", state of the meeting

meetingSource

string

ex: "EMAIL_DROP", source of where the meeting was booked

schedulerId

long

ID of scheduling contact (site visitor)

eventId

string

Calendar event ID.

slug

string

Meeting ID

slotStart

long

Milliseconds (timestamp). Up to 30 days ago.

slotEnd

long

Milliseconds (timestamp)

updatedAt

long

Milliseconds (timestamp). Last time updated.

scheduledAt

long

Milliseconds (timestamp). Time that the meeting was booked by a site visitor.

meetingType

string

ex: "New Meeting", stating the type of the meeting.

conversationId

long

Conversation ID (if present).

endUserTimeZone

string

Timezone ID if present.

meetingNotes

string

Meeting notes left by end user if any.

bookedBy

int

Drift ID for the user if present

📘

Meetings can't be deleted or created via the API

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


Did this page help you?