Skip to navigation
API referenceMeetings

Send an expert to a meeting

A bot joins the call now, or at scheduledAt. Costs money and joins calls with people outside your workspace, so it needs the separate meetings:join scope. Send an Idempotency-Key header so a retry never sends a second bot.

Needs the meetings:join scope. A key without it gets 403 insufficient_scope. Routes not in this reference cannot be called with a key at all (403 not_available_to_api_keys).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

Idempotency-KeystringOptional

Any unique string; a retry with the same key returns the first result instead of acting twice.

Request

This endpoint expects an object.
joinUrlstringRequired

A Google Meet, Zoom or Teams link (a whole invite is fine; the link is extracted).

agentIdstringOptional
A UUID.
titlestringOptional
modeenumOptional
Allowed values:
briefstringOptional
What the expert should know going in.
scheduledAtdatetimeOptional
calendarEventIdstringOptional

Response

OK
idstring
A UUID.
orgIdstring
A UUID.
modeenum
Allowed values:
statusenum
createdAtdatetime
agentIdstring or nullOptional
titlestring or nullOptional
briefstring or nullOptional
platformstring or nullOptional
joinUrlstring or nullOptional
scheduledAtdatetime or nullOptional
startedAtdatetime or nullOptional
endedAtdatetime or nullOptional
updatedAtdatetimeOptional

Errors

401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
429
Too Many Requests Error