Skip to main content
PATCH
/
calendar
/
scheduled
/
{bot_id}
Update Scheduled Bot
curl --request PATCH \
  --url https://api.meestream.ai/api/v1/calendar/scheduled/{bot_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "scheduled_join_time": "2023-11-07T05:31:56Z",
  "bot_username": "<string>",
  "custom_attributes": {},
  "transcription_enabled": true,
  "recording_enabled": true,
  "screenshot_enabled": true
}
'
{
  "message": "<string>",
  "bot_id": "<string>",
  "updated_fields": [
    "<string>"
  ],
  "schedule_updated": true
}

​
Overview

Updates configuration of a scheduled bot. Allows you to modify the join time, bot username, custom attributes, and feature flags. Cannot update active bots that are currently in a meeting.

​
Request

Endpoint: PATCH /calendar/scheduled/{bot_id} or PATCH /calendar/schedule/{bot_id} Headers: 
Authorization: Token <api_key>
Path Parameters:
ParameterTypeRequiredDescription
bot_idstringYesThe BotID of the scheduled bot
Request Body: 
{
  "scheduled_join_time": "2024-12-20T10:00:00Z",
  "bot_username": "Updated Bot Name",
  "custom_attributes": {
    "key": "value"
  },
  "transcription_enabled": true,
  "recording_enabled": true,
  "screenshot_enabled": false
}

​
Request Body Parameters

All parameters are optional. Only include the fields you want to update.
ParameterTypeRequiredDescription
scheduled_join_timeISO 8601NoNew scheduled join time (must be in the future)
bot_usernamestringNoNew bot display name
custom_attributesobjectNoCustom attributes to update (merges with existing)
transcription_enabledbooleanNoEnable/disable transcription
recording_enabledbooleanNoEnable/disable recording
screenshot_enabledbooleanNoEnable/disable screenshots

​
Response

​
Success Response (200)

{
  "message": "Scheduled bot updated successfully",
  "bot_id": "uuid",
  "updated_fields": ["scheduled_join_time", "bot_username"],
  "schedule_updated": true
}

​
Response Fields

FieldTypeDescription
messagestringSuccess message
bot_idstringThe bot ID that was updated
updated_fieldsarrayList of field names that were updated
schedule_updatedbooleanWhether the EventBridge schedule was updated

​
Error Responses

​
400 Bad Request

  • Invalid JSON in request body
  • Invalid datetime format for scheduled_join_time
  • No valid update fields provided
  • Bot is not scheduled
  • Cannot update active bot (bot is currently in a meeting)
  • scheduled_join_time is not in the future

​
401 Unauthorized

Missing user_id in token or invalid authentication.

​
403 Forbidden

Bot does not belong to the authenticated user.

​
404 Not Found

Bot not found.

​
500 Internal Server Error

An error occurred while updating the bot.

​
Usage Examples

​
Update Join Time

PATCH /calendar/scheduled/5b0ff6e7-3cea-4c9f-a6b4-851c5f11cf4f
Content-Type: application/json

{
  "scheduled_join_time": "2024-12-20T09:55:00Z"
}

​
Update Bot Username and Features

PATCH /calendar/scheduled/5b0ff6e7-3cea-4c9f-a6b4-851c5f11cf4f
Content-Type: application/json

{
  "bot_username": "My Custom Bot Name",
  "transcription_enabled": true,
  "recording_enabled": false
}

​
Update Custom Attributes

PATCH /calendar/scheduled/5b0ff6e7-3cea-4c9f-a6b4-851c5f11cf4f
Content-Type: application/json

{
  "custom_attributes": {
    "department": "Engineering",
    "project": "Q4 Initiative"
  }
}
Custom attributes are merged with existing attributes. To remove an attribute, set it to null.
You cannot update a bot that is currently active (status: “InMeeting”). Wait for the bot to leave the meeting or stop it first.

Authorizations

​
Authorization
string
header
required

All API endpoints are authenticated using API Keys. The key should be included in the 'Authorization' header, prefixed with 'Token '. Example: 'Authorization: Token YOUR_API_KEY'.

Path Parameters

​
bot_id
string
required

The BotID of the scheduled bot.

Body

application/json
​
scheduled_join_time
string<date-time>

New scheduled join time (must be in the future)

​
bot_username
string

New bot display name

​
custom_attributes
object

Custom attributes to update (merges with existing)

​
transcription_enabled
boolean

Enable/disable transcription

​
recording_enabled
boolean

Enable/disable recording

​
screenshot_enabled
boolean

Enable/disable screenshots

Response

Scheduled bot updated successfully.

​
message
string
required

Success message

​
bot_id
string
required

The bot ID that was updated

​
updated_fields
string[]

List of field names that were updated

​
schedule_updated
boolean

Whether the EventBridge schedule was updated