OpenIMDocs

Type at least two characters to search titles and routes.

EN

Language

ENEnglishEnglish docs简中简体中文中文文档
Browse Platform API
Platform APIEnterprise

Update a meeting

Copy

Update selected meeting information, recurrence settings, participant permissions, and invitees.

HTTP request

POST {API_ADDRESS}/rtc-meeting/update_meeting

Request example

curl --request POST "${API_ADDRESS}/rtc-meeting/update_meeting" --header "Content-Type: application/json" --header "operationID: ${OPERATION_ID}" --header "token: ${TOKEN}" --data-raw '{"meetingID":"meeting_001","updatingUserID":"user_001","title":"Updated weekly sync","scheduledTime":1719900000000,"meetingDuration":3600,"password":"123456","timeZone":"Asia/Shanghai","repeatInfo":{"endDate":1722400000000,"repeatTimes":4,"repeatType":1,"interval":1,"repeatDaysOfWeek":[1],"repeatMeetingID":"repeat_meeting_001","repeatSequence":1},"canParticipantsEnableCamera":true,"canParticipantsUnmuteMicrophone":true,"canParticipantsShareScreen":true,"disableCameraOnJoin":false,"disableMicrophoneOnJoin":true,"canParticipantJoinMeetingEarly":false,"lockMeeting":false,"audioEncouragement":true,"videoMirroring":true,"inviteeInfo":{"inviteeUserIDs":["user_002"]}}'

Request body

ParameterRequiredTypeDescription
meetingIDYesstringMeeting ID.
updatingUserIDYesstringUser performing the update.
titleNoStringValueNew title.
scheduledTimeNoInt64ValueNew start time in Unix milliseconds.
meetingDurationNoInt64ValueNew duration in seconds.
passwordNoStringValueNew password, including an empty value to remove it.
timeZoneNoStringValueNew creator-selected time zone.
repeatInfoYesMeetingRepeatInfoRecurrence information associated with this meeting.
canParticipantsEnableCameraNoBoolValueWhether participants may enable cameras.
canParticipantsUnmuteMicrophoneNoBoolValueWhether participants may unmute microphones.
canParticipantsShareScreenNoBoolValueWhether participants may share screens.
disableCameraOnJoinNoBoolValueWhether cameras start disabled.
disableMicrophoneOnJoinNoBoolValueWhether microphones start muted.
canParticipantJoinMeetingEarlyNoBoolValueWhether participants may join early.
lockMeetingNoBoolValueWhether new participants are blocked from joining.
audioEncouragementNoBoolValueWhether active-speaker highlighting is enabled.
videoMirroringNoBoolValueWhether video mirroring is enabled.
inviteeInfoYesInviteeInfoUpdated invitee user IDs.

Response

The common response has errCode: 0 when the update was accepted.

Errors

See Error codes.

Permissions and limits

  • Available only in OpenIM Enterprise.
  • Use wrapper fields to distinguish omitted values from explicit zero, empty, or false values.