Sign in

v4

latestOpenAPI 3.0.32026-08-05112308736.8 KB
bot

Send Chat Message

Causes the bot to send a message in the meeting chat.

The base rate limit for this endpoint is:

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

Path parameters

idstring uuid required

A UUID string identifying this bot.

Request body

tostring

The person or group that the message will be sent to. On non-Zoom platforms, "everyone" is currently the only supported option, meaning the message will be sent to everyone in the meeting.

messagestring required

The message that will be sent.

pinboolean

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