PUT /chat/users/{userId}/messages/{messageId}

Each chat message has a unique identifier. Use this API to edit a chat message that you previously sent to either a contact or a channel in Zoom by providing the ID of the message as the value of the messageId parameter. The ID can be retrieved from List User's Chat Messages API. Additionally, as a query parameter, you must provide either the email address of the contact or the Channel ID of the channel where the message was sent.

Scope: chat_message:write,chat_message:write:admin
Rate Limit Label: Medium

For an account-level OAuth app, this API can only be used on behalf of a user who is assigned with a role that has Edit permission for Chat Messages.

Scope: chat_message:write, chat_message:write:admin

Servers

Path parameters

Name Type Required Description
userId String Yes
messageId String Yes

Message ID: Unique Identifier of the message.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
message String No

The edited message.

to_channel String No

The Channel ID of the channel where you sent the message.
You must provide either to_contact or to_channel parameter in the API request. Channel ID can be retrieved from List User's Channels API.

to_contact String No

The email address of the contact to whom the message was sent.
You must provide either to_contact or to_channel parameter in the API request.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.