Introduction
Using Zoom APIs
Pagination
Error Definitions
Rate Limits
Testing Zoom APIs with Postman
Accounts
Archiving
Billing
Chat Channels
Chat Channels (Account-level)
Chat Messages
Contacts
Cloud Recording
Dashboards
Devices
Groups
IM Chat
IM Groups
Meetings
PAC
Reports
Roles
SIP Connected Audio
SIP Phone
Tracking Field
TSP
Users
Webinars
Zoom Rooms
Zoom Rooms Account
Zoom Rooms Location
Zoom Rooms Devices
Deprecated API Endpoints
Phone
Phone Auto Receptionists
Phone Blocked List
Phone Call Queues
Phone Devices
Phone Reports
Phone Shared Line Groups
Phone Site
Common Area Phones
SMS
Provider Exchange
Archiving Events
Account Events
App Events
Billing Events
Chat Message Events
Chat Channel Events
Chatbot Events
Meeting Events
Phone Events
Recording Events
TSP Events
User Events
Webinar Events
Zoom Room Events
Deprecated API Endpoints
put

/im/chat/messages/{message_id}

Edit a message that was sent by your Chatbot app.
After sending a message using the Send Chatbot Message API, you must store the messageId returned in the response so that you can make edits to the associated message using this API.

Scope: imchat:bot
Rate Limit Label: Medium
Authorization Flow: Client Credentials Flow

To get authorized, make a POST request to /oauth/token endpoint with grant type as client_credentials.
Use https://api.zoom.us/oauth/token?grant_type=client_credentials as the endpoint for the request. You will need to send your ClientID and Secret as a Basic base64 encoded AUthorization header. Ex. Basic base64Encode({client_id}:{client_sceret})

Next, use the token received (access_token) as a bearer token while making the PUT /im/chat/messages/{message_id} request to edit a chatbot message.

Learn more about how to authotize chatbots in the Chatbot Authorization guide.

Authorization

oauth2 - clientCredentials

Request Parameters

1 Path Parameter

Request Body

1 Example
Schema
object
robot_jid
string

Robot JID created when enabling chatbot features on your marketplace app.

required
account_id
string

The AccountID of the Zoom account to which the message was sent. Retrieve this from the Chatbot request sent to your server as shown in the example here.

required
content
object

JSON template describing how the edited message should be displayed for the user. For more information please see our “Send Message” templates.

required
user_jid
string

Optional
The UserJID of the user on whose behalf the message is being sent. Use this field to prevent members of a channel from getting notifications that were set up by a user who has left the channel.

is_markdown_support
boolean

Optional
Enable or disable markdown parser to your chatbot message. Applies the markdown parser to your chatbot message if the value of this field is set to true.
To learn more, refer to the Chatbot message markdown reference.

Responses

HTTP Status Code: 200 OK
Message updated.

1 Example
Schema
object
message_id
string

Unique Identifier of the updated message,

robot_jid
string

The BotJID found in the Chat Subscription Section on the Features page of your App Dashboard.

sent_time
string

The date and time at which the message was sent.

1 validation
to_jid
string

The JID of the Channel or User to whom the message was sent.

user_jid
string

The UserJID of the user on whose behalf the message is being sent. Used to prevent members of a channel from getting notifications that were set up by a user who has left the channel.

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
message_id
$$.env
1 variable not set
oauth_access_token