Skip to main content
PATCH
Update a meeting's metadata

Authorizations

Authorization
string
header
required

Your API key, sent bare. See Authentication.

Path Parameters

id
string
required

Meeting ID, beginning with mtg_. Treat it as an opaque string.

Example:

"mtg_01k6a2r9s8x7c2dvq3m5n6p4ab"

Body

application/json
metadata
required

Merged into the object's metadata: the keys you send are added or overwritten and the others kept. "" as a value removes that key; metadata: "" removes every key. Numbers and booleans are stored as their text; objects, arrays and null are refused.

Example:

Response

The meeting.

Which label to show for a meeting, read from the fields that own it:

id
string

Beginning with mtg_. Stays the same through reschedules, URL changes and bot retries.

object
string

Always meeting.

workspace_id
string

Workspace ID, beginning with wks_. Treat it as an opaque string.

Example:

"wks_01k6a2r9s8x7c2dvq3m5n6p4ab"

source
enum<string>

Where the meeting came from.

  • calendar_connection: a calendar the member connected.
  • calendar_sync: an event you pushed with POST /calendar_events.
  • bot: a bot you sent with POST /bots.
Available options:
calendar_connection,
calendar_sync,
bot
phase
enum<string>

About time only; what happens after the call is in results.

  • upcoming: not started, and nothing recording yet.
  • live: a recording is active. An early start counts: activity beats the calendar.
  • past: the recording ended, or the scheduled end went by.
  • cancelled: the source event was cancelled. Listed only with phase=cancelled.
Available options:
upcoming,
live,
past,
cancelled
title
string | null

The calendar event's title, or a generated one for a bot sent without a calendar event.

starts_at
string<date-time> | null

A bot meeting starts at the bot's join_at.

ends_at
string<date-time> | null

Scheduled end, or null when unknown.

meeting_url
string | null

The link to join the call, or null when the event has none.

platform
enum<string> | null

The meeting platform, from the link. null for any other link (Webex, a dial-in page) or none.

  • meet: Google Meet.
  • zoom: Zoom.
  • teams: Microsoft Teams, Teams Live included.
Available options:
meet,
zoom,
teams,
null
organizer
object | null

Who organizes the meeting, or null when unknown.

participants
object[]

The people on the invite, or given when the bot was sent.

calendar_event
object | null

The calendar event of this meeting, the object POST /calendar_events returns. null for bot meetings.

Example:
settings
object

What applies to this meeting, which assignment supplied each value, and every assignment that reaches it. On List meetings, only with include=settings.

Example:
recordings
object[]

How audio came in. Each bot sent to the meeting, oldest first.

results
object

Statuses only. The content is at GET /meetings/{id}/results.

metadata
object

Yours; change it with PATCH /meetings/{id}. Never used to identify a meeting.

Example:
created_at
string<date-time>

When the meeting first appeared, in ISO 8601.

updated_at
string<date-time>

When anything in the meeting last changed, in ISO 8601.