DataFlex / Zoom API / Update a message
Back to Collection Items
Use ChilkatAx-9.5.0-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vReq
Handle hoReq
Variant vResp
Handle hoResp
Integer iRespStatusCode
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Get Create (RefClass(cComChilkatHttpRequest)) To hoReq
If (Not(IsComObjectCreated(hoReq))) Begin
Send CreateComObject of hoReq
End
Set ComHttpVerb Of hoReq To "PUT"
Set ComPath Of hoReq To "/v2/chat/users/:userId/messages/:messageId"
Set ComContentType Of hoReq To "multipart/form-data"
Send ComAddParam To hoReq "message" "quis qui"
Send ComAddParam To hoReq "to_contact" "quis quinon dolore enim in"
Send ComAddParam To hoReq "to_channel" "quis quinon dolore enim involuptate tempor velit"
Send ComAddHeader To hoReq "Authorization" "Bearer <access_token>"
Get pvComObject of hoReq to vReq
Get ComSynchronousRequest Of hoHttp "api.zoom.us" 443 True vReq To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode <> 204) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Response Body:"
Get ComBodyStr Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
Showln "Success."
End_Procedure
Curl Command
curl -X PUT
-H "Authorization: Bearer <access_token>"
-H "Content-Type: multipart/form-data"
--form 'message=quis qui'
--form 'to_contact=quis quinon dolore enim in'
--form 'to_channel=quis quinon dolore enim involuptate tempor velit'
https://api.zoom.us/v2/chat/users/:userId/messages/:messageId
Postman Collection Item JSON
{
"name": "Update a message",
"request": {
"auth": {
"type": "oauth2"
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "multipart/form-data"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "message",
"value": "quis qui",
"description": "The edited message.",
"type": "text"
},
{
"key": "to_contact",
"value": "non dolore enim in",
"description": "The email address of the contact to whom the message was sent.<br>\nYou must provide either `to_contact` or `to_channel` parameter in the API request.",
"type": "text"
},
{
"key": "to_channel",
"value": "voluptate tempor velit",
"description": "The Channel ID of the channel where you sent the message.<br>You must provide either `to_contact` or `to_channel` parameter in the API request.\n Channel ID can be retrieved from List User's Channels API. ",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/chat/users/:userId/messages/:messageId",
"host": [
"{{baseUrl}}"
],
"path": [
"chat",
"users",
":userId",
"messages",
":messageId"
],
"variable": [
{
"key": "messageId",
"value": "quis officia in reprehenderit",
"description": "(Required) Message ID: Unique Identifier of the message."
}
]
},
"description": "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. You can get the ID from the **List User's Chat Messages** API. Additionally, as a query parameter, you must provide either the contact's **email address** of the contact or the **Channel ID** of the channel where the message was sent.\n\nFor user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\n<p style=\"background-color:#e1f5fe; color:#01579b; padding:8px\"> <b>Note:</b> For an <b>account-level</b> <a href=\"https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app\">OAuth app</a>, this API can only be used on behalf of a user who is assigned with a <a href=\"https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.\"> role</a> that has the <b>Edit</b> permission for <b>Chat Messages</b>.</p>\n\n**Scope:** `chat_message:write`,`chat_message:write:admin`\t<br>\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`"
},
"response": [
{
"name": "**HTTP Status Code:** `204`<br>\nMessage updated successfully.",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "message",
"value": "quis qui",
"description": "The edited message.",
"type": "text"
},
{
"key": "to_contact",
"value": "non dolore enim in",
"description": "The email address of the contact to whom the message was sent.<br>\nYou must provide either `to_contact` or `to_channel` parameter in the API request.",
"type": "text"
},
{
"key": "to_channel",
"value": "voluptate tempor velit",
"description": "The Channel ID of the channel where you sent the message.<br>You must provide either `to_contact` or `to_channel` parameter in the API request.\n Channel ID can be retrieved from List User's Channels API. ",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/chat/users/:userId/messages/:messageId",
"host": [
"{{baseUrl}}"
],
"path": [
"chat",
"users",
":userId",
"messages",
":messageId"
],
"variable": [
{
"key": "messageId",
"value": "quis officia in reprehenderit",
"description": "(Required) Message ID: Unique Identifier of the message."
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "**HTTP Status Code:** `400`<br>\nBar request<br>\n**Error Code:** `200`<br>\nOnly the sender of this message can make updates.<br>\n**Error Code:** `300`<br>\nMessage does not exist: $messageId <br> Must provide either contact or channel parameter.\n",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "message",
"value": "quis qui",
"description": "The edited message.",
"type": "text"
},
{
"key": "to_contact",
"value": "non dolore enim in",
"description": "The email address of the contact to whom the message was sent.<br>\nYou must provide either `to_contact` or `to_channel` parameter in the API request.",
"type": "text"
},
{
"key": "to_channel",
"value": "voluptate tempor velit",
"description": "The Channel ID of the channel where you sent the message.<br>You must provide either `to_contact` or `to_channel` parameter in the API request.\n Channel ID can be retrieved from List User's Channels API. ",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/chat/users/:userId/messages/:messageId",
"host": [
"{{baseUrl}}"
],
"path": [
"chat",
"users",
":userId",
"messages",
":messageId"
],
"variable": [
{
"key": "messageId",
"value": "quis officia in reprehenderit",
"description": "(Required) Message ID: Unique Identifier of the message."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "**HTTP Status Code:** `404`<br>\n**Error Code**: `1001`<br>\nUser does not exist: $to_contact.<br>\n**Error Code**: `4130`<br>\nChannel does not exist: $to_channel.",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "message",
"value": "quis qui",
"description": "The edited message.",
"type": "text"
},
{
"key": "to_contact",
"value": "non dolore enim in",
"description": "The email address of the contact to whom the message was sent.<br>\nYou must provide either `to_contact` or `to_channel` parameter in the API request.",
"type": "text"
},
{
"key": "to_channel",
"value": "voluptate tempor velit",
"description": "The Channel ID of the channel where you sent the message.<br>You must provide either `to_contact` or `to_channel` parameter in the API request.\n Channel ID can be retrieved from List User's Channels API. ",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/chat/users/:userId/messages/:messageId",
"host": [
"{{baseUrl}}"
],
"path": [
"chat",
"users",
":userId",
"messages",
":messageId"
],
"variable": [
{
"key": "messageId",
"value": "quis officia in reprehenderit",
"description": "(Required) Message ID: Unique Identifier of the message."
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}