Update a meeting

Update a meeting.

Note: You can only update meeting(s) that have not started yet.

Request URL

PUT {base_url}/services/openapi/v1.0/room/meeting_update

Request parameters

Body parameters

Important: It is recommended to include all the parameters in an update request, as parameters not included in the request might be set to NULL or reset to default settings.
Parameter Required Type Description
meetingId Yes String Meeting ID.
Note: You can query the meeting ID using the Query Multiple Meetings interface.
updateScope No String Update scope for recurring meetings.
Valid value:
  • ALL (Default): Update all the related recurring meetings.
  • SELECTED: Only update the meeting specified by the meeting ID.
  • SELECTED_AND_AFTER: Update the meeting specified by the meeting ID, and all its subsequent recurring meetings.
subject Yes String The subject of the meeting.
startTime Yes Long The start time of the meeting.
Note: Enter timestamp instead of exact date and time. For example, 1689928200.
endTime Yes Long The end time of the meeting.
Note:
hostId Yes Long The member ID of the meeting organizer.
Note: You can query the user's member ID using the Query Multiple Users interface.
participantIds No Array <Long> The member ID(s) of internal participant(s).
Note:
  • You can query the user's member ID using the Query Multiple Users interface.
  • Use a comma to separate multiple IDs. For example, [1001,1002].
guestEmails No Array <String> The email address(es) of external participant(s).
Note: Use a comma to separate multiple email addresses. For example, ["test@yeastar.com","test2@yeastar.com"].
roomId Yes Long The ID of the meeting room.
Note: You can query the meeting room ID using the Query Multiple Meeting Rooms interface.
notificationTimes No Array <Integer> How far in advance should the system send meeting reminders to participants before the meeting starts. (Unit: minute).
Valid range: 5 - 1440.
Note:
  • If you don't want to send meeting notifications, leave it empty.
  • Use comma to separate multiple values. For example, [15,30].
online No Boolean Whether the meeting is a Microsoft Teams online meeting.
Note: This parameter only takes effect when Yeastar Workplace is integrated with Microsoft Teams or Microsoft 365.
Valid value:
  • true: Yes.
  • false: No.
repeat No Object <Repeat_Strategy> The recurrence pattern of recurring meetings.
meetingServices No Array <Meeting_Services> The services for the meeting.
remark No String Remark.
Repeat_Strategy
Parameter Required Type Description
type Yes String Recurring type.
  • DAILY: Repeat every few days.
  • WEEKLY: Repeat on a specific weekday of every few weeks.
  • ABSOLUTE_MONTHLY: Repeat on a specific date of every few months.
  • RELATIVE_MONTHLY: Repeat on a specific weekday of every few months.
frequency Yes Integer Recurring frequency.
dayOfWeek No Array <Integer> The specific weekday of the week.

Valid range: 1 - 7.

Note: 1 represents Monday, and so on in sequence.
dayOfMonth No Interger The specific date of the month.

Valid range: 1 - 31.

Note: -1 represents the last day of a month.
weekOfMonth No Integer The Xth specific weekday of the month.

Valid range: -1 - 5.

Note: 1 represents the first one, while -1 represents the last one.
endDate Yes String The end date of the meeting recurring.
Note: Enter the date using the ISO-8601 format with timezone extension, namely YYYY-MM-DDThh:mm:ssTZD. For example, 2023-01-01T00:00:00+08:00[Asia/Shanghai].
Meeting_Services
Parameter Required Type Description
serviceType Yes String The name of the meeting service.
notificationRules No Array <Notif_Rule> The notification rule of the meeting service.
contactIds Yes Array <Long> The member ID of the internal service contacts.
Note: Use a comma to separate multiple IDs. For example, [1001,1002].
serviceRemark No String Remark for the meeting service.
Rotif_Rule
Parameter Required Type Description
meetingStatus No String The meeting status based on which the system will send notifications to server contacts.
  • NOT_STARTED: Send service notification before the meeting starts. You can specify the time window using the notificationTime parameter.
  • ENDED: When the meeting ends.
notificationTime No Integer How far in advance will the system send service notifications to the related service contacts before the meeting starts(Unit: minute).

Response parameters

Parameter Type Description
status String The result of the request.
  • Success
  • Failed
requestId String The ID of the request, which can be used to quickly locate the request.

Example

Request example

Change the time of a specific meeting in recurring meetings:
  • Meeting ID: WzEsNzUyMjUsMCwxNjkwOTU3ODAwLDBd.
  • Change the meeting time to 2023-07-26 09:30:00 ~ 2023-07-26 10:30:00.
Important: It is recommended to include all the parameters in an update request, as parameters not included in the request might be set to NULL or reset to default settings.
PUT /services/openapi/v1.0/room/meeting_update HTTP/1.1
Host: workplace.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJncmFudF90eXBlIjoiY2xpZW50X2NyZWRlbnRpYWxzIiwic2NvcGUiOlsiL29wZW5hcGkvIl0sImVudGVycHJpc2VfaWQiOjEwMDQzMywicmVnaW9uIjoiR0wiLCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiJiZTc0ZGY0OS1hNjdmLTQ2NzMtYTkzMi1iMzY3YWY4NDM5ZjYiLCJjbGllbnRfaWQiOiI3OTU2OGFhMC0wYjBkLTQyZjYtOGRiNC03OWExNmQ3MzQ3MmEiLCJ0cyI6MTY5MDE4MTA0NCwiZXhwX2luIjo4NjQwMH0.jEj9xU4KGu4phUKaIX1WLX_aW6ycjcU-iJV1_9b73QU
Content-Type: application/json

{
    "meetingId":"WzEsNzUyMjUsMCwxNjkwOTU3ODAwLDBd",
    "updateScope":"SELECTED",
    "subject": "Monthly Meeting",
    "startTime": 1690335000,
    "endTime": 1690338600,
    "hostId": 466,
    "participantIds": [3084],
    "guestEmails": ["test@yeastar.com"],
    "roomId": 2810,
    "notificationTimes": [15],
    "online":false,
    "repeat":{
        "type":"RELATIVE_MONTHLY",
        "frequency":1,
        "weekOfMonth":1,
        "dayOfWeek":[3],
        "endDate":"2024-07-23T00:00:00+10:00[Australia/Sydney]"
    },
    "meetingServices":[
      {
        "serviceType":"Tech Support",
        "notificationRules":[
            { 
               "meetingStatus":"NOT_STARTED",
               "notificationTime":15
             }
        ],
        "contactIds":[3084,2904],
        "serviceRemark": "Test service"
       }
    ],
    "remark": "A Monthly Meeting"
}
Response example
HTTP/1.1 200 OK
{
    "status": "Success",
    "requestId": "8c2a9809ef3224a53b17a3a6d6007b38"
}