Sign in

v3

latestOpenAPI 3.0.32026-07-31112307733.3 KB
bot

Pin Participant

Pin or unpin a participant's video. Note: This is only applicable for 'video_separate_h264' streams

The base rate limit for this endpoint is:

  • 300 requests per min per workspace
post/api/v1/bot/{id}/pin_participant/

Path parameters

idstring uuid required

A UUID string identifying this bot.

Request body

idinteger

The ID of the participant to pin. If not specified, the bot will unpin any currently pinned participant.

Response

idstring uuid required
bot_namestring

The name of the bot that will be displayed in the call. (Note: Authenticated Google Meet bots will use the Google account name and this field will be ignored.)

join_atstring date-time nullable

The time at which the bot will join the call, formatted in ISO 8601. This field can only be read from scheduled bots that have not yet joined a call.

metadataobject