Chilkat Online Tools

Mono / Zoom API / Mark message read or unread

Back to Collection Items

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

Chilkat.Http http = new Chilkat.Http();
bool success;

Chilkat.HttpRequest req = new Chilkat.HttpRequest();
req.HttpVerb = "PATCH";
req.Path = "/v2/chat/users/:userId/messages/:messageId/status";
req.ContentType = "multipart/form-data";
req.AddParam("timestamp","-53093651");

req.AddParam("to_contact","-53093651Duis anim");

req.AddParam("to_channel","-53093651Duis animipsum id ut");

req.AddParam("action","-53093651Duis animipsum id utamet est ea qui");

req.AddHeader("Authorization","Bearer <access_token>");

Chilkat.HttpResponse resp = http.SynchronousRequest("api.zoom.us",443,true,req);
if (http.LastMethodSuccess == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

int respStatusCode = resp.StatusCode;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode != 204) {
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(resp.Header);
    Debug.WriteLine("Response Body:");
    Debug.WriteLine(resp.BodyStr);
    Debug.WriteLine("Failed.");

    return;
}

Debug.WriteLine("Success.");

Curl Command

curl -X PATCH
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: multipart/form-data"
	--form 'timestamp=-53093651'
	--form 'to_contact=-53093651Duis anim'
	--form 'to_channel=-53093651Duis animipsum id ut'
	--form 'action=-53093651Duis animipsum id utamet est ea qui'
https://api.zoom.us/v2/chat/users/:userId/messages/:messageId/status

Postman Collection Item JSON

{
  "name": "Mark message read or unread",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "PATCH",
    "header": [
      {
        "key": "Content-Type",
        "value": "multipart/form-data"
      }
    ],
    "body": {
      "mode": "formdata",
      "formdata": [
        {
          "key": "timestamp",
          "value": "-53093651",
          "description": "The marking message's timestamp.",
          "type": "text"
        },
        {
          "key": "to_contact",
          "value": "Duis anim",
          "description": "The email address of the contact to whom the message was sent.<br>\nYou must provide either a `to_contact` or `to_channel` parameter in the API request.",
          "type": "text"
        },
        {
          "key": "to_channel",
          "value": "ipsum id ut",
          "description": "The Channel ID of the channel where you sent the message.<br>You must provide either a `to_contact` or `to_channel` parameter in the API request.\n You can retrieve the Channel ID using the [List User's Channels API](https://marketplace.zoom.us/docs/api-reference/zoom-api/chat-channels/getchannels). ",
          "type": "text"
        },
        {
          "key": "action",
          "value": "amet est ea qui",
          "description": "Values include <br>`read` or `unread`.",
          "type": "text"
        }
      ]
    },
    "url": {
      "raw": "{{baseUrl}}/chat/users/:userId/messages/:messageId/status",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "chat",
        "users",
        ":userId",
        "messages",
        ":messageId",
        "status"
      ],
      "variable": [
        {
          "key": "userId",
          "value": "quis officia in reprehenderit",
          "description": "(Required) Unique identifier of the user."
        },
        {
          "key": "messageId",
          "value": "quis officia in reprehenderit",
          "description": "(Required) Unique identifier of the message."
        }
      ]
    },
    "description": "Use this API to mark a chat message as read or unread. For 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**Note:** \n\nFor an [account-level OAuth app](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app), this API can only be used on behalf of a [user assigned to a role](https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management) with the \"**Edit**\" permission for **Chat Messages**. \n\n**Scopes:** `chat_message:write`, `chat_message:write:admin` <br> **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`"
  },
  "response": [
    {
      "name": "**HTTP Status Code:** `204`<br>\nMessage marked successfully.",
      "originalRequest": {
        "method": "PATCH",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "timestamp",
              "value": "-53093651",
              "description": "The marking message's timestamp.",
              "type": "text"
            },
            {
              "key": "to_contact",
              "value": "Duis anim",
              "description": "The email address of the contact to whom the message was sent.<br>\nYou must provide either a `to_contact` or `to_channel` parameter in the API request.",
              "type": "text"
            },
            {
              "key": "to_channel",
              "value": "ipsum id ut",
              "description": "The Channel ID of the channel where you sent the message.<br>You must provide either a `to_contact` or `to_channel` parameter in the API request.\n You can retrieve the Channel ID using the [List User's Channels API](https://marketplace.zoom.us/docs/api-reference/zoom-api/chat-channels/getchannels). ",
              "type": "text"
            },
            {
              "key": "action",
              "value": "amet est ea qui",
              "description": "Values include <br>`read` or `unread`.",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{baseUrl}}/chat/users/:userId/messages/:messageId/status",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "chat",
            "users",
            ":userId",
            "messages",
            ":messageId",
            "status"
          ],
          "variable": [
            {
              "key": "userId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) Unique identifier of the user."
            },
            {
              "key": "messageId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) 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:** `300`<br>\nMessage does not exist: $messageId <br> Must provide either contact or channel parameter.\n",
      "originalRequest": {
        "method": "PATCH",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "timestamp",
              "value": "-53093651",
              "description": "The marking message's timestamp.",
              "type": "text"
            },
            {
              "key": "to_contact",
              "value": "Duis anim",
              "description": "The email address of the contact to whom the message was sent.<br>\nYou must provide either a `to_contact` or `to_channel` parameter in the API request.",
              "type": "text"
            },
            {
              "key": "to_channel",
              "value": "ipsum id ut",
              "description": "The Channel ID of the channel where you sent the message.<br>You must provide either a `to_contact` or `to_channel` parameter in the API request.\n You can retrieve the Channel ID using the [List User's Channels API](https://marketplace.zoom.us/docs/api-reference/zoom-api/chat-channels/getchannels). ",
              "type": "text"
            },
            {
              "key": "action",
              "value": "amet est ea qui",
              "description": "Values include <br>`read` or `unread`.",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{baseUrl}}/chat/users/:userId/messages/:messageId/status",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "chat",
            "users",
            ":userId",
            "messages",
            ":messageId",
            "status"
          ],
          "variable": [
            {
              "key": "userId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) Unique identifier of the user."
            },
            {
              "key": "messageId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) 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": "PATCH",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "timestamp",
              "value": "-53093651",
              "description": "The marking message's timestamp.",
              "type": "text"
            },
            {
              "key": "to_contact",
              "value": "Duis anim",
              "description": "The email address of the contact to whom the message was sent.<br>\nYou must provide either a `to_contact` or `to_channel` parameter in the API request.",
              "type": "text"
            },
            {
              "key": "to_channel",
              "value": "ipsum id ut",
              "description": "The Channel ID of the channel where you sent the message.<br>You must provide either a `to_contact` or `to_channel` parameter in the API request.\n You can retrieve the Channel ID using the [List User's Channels API](https://marketplace.zoom.us/docs/api-reference/zoom-api/chat-channels/getchannels). ",
              "type": "text"
            },
            {
              "key": "action",
              "value": "amet est ea qui",
              "description": "Values include <br>`read` or `unread`.",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{baseUrl}}/chat/users/:userId/messages/:messageId/status",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "chat",
            "users",
            ":userId",
            "messages",
            ":messageId",
            "status"
          ],
          "variable": [
            {
              "key": "userId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) Unique identifier of the user."
            },
            {
              "key": "messageId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) Unique identifier of the message."
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}