List comments on a message
Returns comments (replies) on a specific shared mailbox message. Use startId and newer for cursor-based pagination, or pageToken for token-based pagination.
Endpoint
Request URL
https://mail.zoho.com/api/v2/sharedmailbox/{mailboxIdentifier}/messages/{messageId}/comments Copied!
Note:
Use the request URL with the domain that matches the DC where your account is hosted. Refer Multiple data centers section for data center information.
Scope
Request Parameters
- Path Parameters
Email address or numeric zgid (group ID) of the shared mailbox group.
Numeric ID of the message (long as string).
- Query Parameters
Maximum number of comments to return per page. Range: 1 to 200. Defaults to 10.
Numeric comment ID (long as string) to use as the cursor for paginating. startId and pageToken are alternative pagination mechanisms; prefer pageToken for token-based pagination.
When true, returns comments in ascending time order (oldest first); when false (default), returns in descending order (newest first).
When true, returns only the most recent comments. Defaults to false.
Filter comments by numeric type. Pass -1 (default) to return all types.
When true, private comments are included alongside parent comments. Defaults to false.
When true, attachment metadata for comments is included in the response. Defaults to false.
Opaque pagination cursor returned by a previous response. Pass to fetch the next page of comments.
Comma-separated list of fields to return in response. When omitted, all fields are returned. Comment fields: commentId, messageVia, user, commentType, sequenceId, customStatus, externalId, authorId, authorName, text, RTF, RTFText, RTFText_sanitized, link, attachments, replyTo, replyToZuid, replyToDisplayName, likesCount, likedBy, tags, reminders, liked, hasPrivateComments, isPrivate, isPrivateToPost, createdAt, lastModifiedAt, privateComments, privateToPostComments, integrationInfos. attachments sub-fields: attachmentId, attachmentName, attachmentType, attachmentSize, attachmentTags, isAttachmentInline, attachmentFormat, isThumbnail, receivedAt, attachmentStatus, commentId, expiryValue, expiryType, scanDetails, sharedEmailIds, timeStamp, displayDate, thumbnailUrl, thumbnailData, isPreviewAvailable, isDeleted and other fields also. scanDetails sub-fields: scanStatus, errorCode, attachmentEncryptionStatus, isScanCacheValid, isEncryptedScanPerformed, lastVirusScanTimestamp.
Sample Request
curl --request GET \
--url 'https://mail.zoho.com/api/v2/sharedmailbox/support@zylker.com/messages/1001234567890/comments?limit=10&startId=2001234567890&newer=false&recentComments=false&commentType=-1&includePrivateComments=false&includeAttachments=true&pageToken=eyJzdGFydCI6MTAsImxpbWl0IjoxMH0&fields=messageId%2Ctitle%2CfromAddress%2CtoAddress%2CcreatedAt%2Cunread' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52'import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;
public class Main {
public static void main(String[] args) throws Exception{
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://mail.zoho.com/api/v2/sharedmailbox/support@zylker.com/messages/1001234567890/comments?limit=10&startId=2001234567890&newer=false&recentComments=false&commentType=-1&includePrivateComments=false&includeAttachments=true&pageToken=eyJzdGFydCI6MTAsImxpbWl0IjoxMH0&fields=messageId%2Ctitle%2CfromAddress%2CtoAddress%2CcreatedAt%2Cunread"))
.header("Authorization", "Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
}
}
import http.client
conn = http.client.HTTPSConnection("mail.zoho.com")
headers = { 'Authorization': "Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52" }
conn.request("GET", "/api/v2/sharedmailbox/support@zylker.com/messages/1001234567890/comments?limit=10&startId=2001234567890&newer=false&recentComments=false&commentType=-1&includePrivateComments=false&includeAttachments=true&pageToken=eyJzdGFydCI6MTAsImxpbWl0IjoxMH0&fields=messageId%2Ctitle%2CfromAddress%2CtoAddress%2CcreatedAt%2Cunread", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
parameters = "limit=10" + "&" + "startId=2001234567890" + "&" + "newer=false" + "&" + "recentComments=false" + "&" + "commentType=-1" + "&" + "includePrivateComments=false" + "&" + "includeAttachments=true" + "&" + "pageToken=eyJzdGFydCI6MTAsImxpbWl0IjoxMH0" + "&" + "fields=messageId%2Ctitle%2CfromAddress%2CtoAddress%2CcreatedAt%2Cunread";
headersMap = Map();
headersMap.put("Accept", "application/json");
response = invokeUrl
[
url: "https://mail.zoho.com/api/v2/sharedmailbox/{mailboxIdentifier}/messages/{messageId}/comments" + "?" + parameters
type: GET
headers: headersMap
connection: connection_name
]
info response;
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://mail.zoho.com/api/v2/sharedmailbox/support@zylker.com/messages/1001234567890/comments?limit=10&startId=2001234567890&newer=false&recentComments=false&commentType=-1&includePrivateComments=false&includeAttachments=true&pageToken=eyJzdGFydCI6MTAsImxpbWl0IjoxMH0&fields=messageId%2Ctitle%2CfromAddress%2CtoAddress%2CcreatedAt%2Cunread",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}Response Parameters
- HTTP code 200
Response Body - application/json
Response envelope for listing comments on a shared mailbox message.
Show Sub-Attributes
Comment list and optional pagination tokens.
Show Sub-Attributes
Map of ZUID to display name for users referenced in comments. Present when the streams new-flow flag is enabled.
Show Sub-Attributes
List of comments on the message.
Show Sub-Attributes
A comment on a shared mailbox message as returned by getCommentJSONV2. Fields are grouped into nested objects.
Show Sub-Attributes
Integration metadata linked to the comment. Present when the comment was created via a Zoho integration.
Show Sub-Attributes
ID of the integrated entity (long as string).
Timestamp of the integration event (long as string).
Integration relation type (e.g. 'CRM', 'DESK').
Display title from the integrated source.
Additional metadata from the integrated source.
Private replies on this comment. Present when includePrivateComments=true and private replies exist.
Show Sub-Attributes
List of private replies on this comment.
Show Sub-Attributes
A private comment visible only to the sender and one recipient, as returned by buildPrivateCommentJSON.
Show Sub-Attributes
ISO 8601 creation time of the private comment.
Integration metadata linked to the private comment. Present when the comment has integration data.
Show Sub-Attributes
ID of the integrated entity (long as string).
Timestamp of the integration event (long as string).
Integration relation type (e.g. 'CRM', 'DESK').
Display title from the integrated source.
Additional metadata from the integrated source.
Author of the private comment.
Show Sub-Attributes
Display name of the author.
Numeric user ID of the author (long as string).
Numeric user ID of the intended recipient (long as string).
Unique numeric ID of the private comment (long as string).
Always 'true' for private comments.
Always 'REST' for private comments created via API.
Content of the private comment.
Show Sub-Attributes
True when the content is rich text.
Raw rich-text (HTML) content. Present when RTF is true.
Plain-text content.
True when RTFText has been sanitized.
Social activity and metadata on the comment.
Show Sub-Attributes
Reminder IDs associated with the comment (long as string each). Present when reminders exist.
Number of likes on the comment.
Numeric user IDs of users who liked the comment (long as string each). Present when likesCount > 0.
Inline quote tags within the comment text, as offset markers into the comment content.
Show Sub-Attributes
Start character offset within the text.
End character offset within the text.
The tagged span of text.
Tag kind. One of: MENTION, HASHTAG, QUOTE, TWEET_MENTION, LINK.
Reply-to context when the comment is a threaded reply to another comment. Present only when replyTo is set.
Show Sub-Attributes
Display name of the parent comment's author.
Comment ID of the parent comment being replied to.
Numeric user ID of the parent comment's author (long as string).
Text snippet of the parent comment. Present when requested via addlData.
Timestamps for the comment.
Show Sub-Attributes
ISO 8601 creation time of the comment.
Last modification time in epoch milliseconds (long as string). Present when the comment has been edited.
Author identity of the comment.
Show Sub-Attributes
Display name of the comment author.
Numeric user ID of the comment author (long as string).
Core comment identity fields.
Show Sub-Attributes
Custom status value. Present when > 0.
Numeric type of the comment. Present when > 0.
Unique numeric ID of the comment (long as string).
External identifier for migrated or integrated comments.
True when posted by a real user (false for auto-generated system comments).
Sequence ID of the comment (long as string). Present when > 0.
Channel through which the comment was posted ('web' or 'mobile').
State flags for the comment.
Show Sub-Attributes
True when there are private replies visible to the current user.
True when this comment is a private reply to another comment.
True when the current user has liked the comment.
True when this is a private-to-post comment visible only to the message owner.
Comment body and media.
Show Sub-Attributes
Attachments on the comment. Present when includeAttachments=true.
Show Sub-Attributes
An attachment on a message or comment as returned by AttachmentInfoImpl.toJSONV2 + AttachStoreInfoImpl.toJSONV2. All keys match AttachmentJSONConstantsV2.
Show Sub-Attributes
Source namespace/user ID associated with the attachment (long as string).
True when the attachment can be sanitized/bleached. Present only when true.
Application type for cloud attachments. Present when > 0.
Attachment type code (e.g. inline, regular, cloud, huge).
Document ID associated with the attachment for Zoho Docs integration.
Attachment status code.
Content ID for inline (embedded) attachments. Present when set.
Document ID for open-with integrations. Present when set.
Share type of the attachment.
True when the attachment is password-protected. Present only when true.
True when the attachment has been deleted. Present only when true.
Expiry type for time-limited attachment links. Present when set.
Content digest/hash of the attachment. Present when set.
Numeric attachment ID (long as string).
Image height in pixels. Present when thumbnail dimensions are available.
True when the attachment is inline (embedded in the body).
Public/shared URL for cloud-linked or huge attachments.
Expiry value for time-limited attachment links. Present when set.
Server-inferred file format when the extension is missing or ambiguous. Present when set.
Virus/malware scan details for the attachment.
Show Sub-Attributes
Epoch timestamp of the last virus scan.
True when the cached scan result is still valid.
True when an encrypted scan was performed.
Result of the virus scan (e.g. 'CLEAN', 'INFECTED').
Scan error code. Present when scanStatus indicates an error.
Encryption status code of the attachment.
True when a web preview is available for this attachment.
True when this is a thumbnail attachment.
Label/tag IDs associated with the attachment.
MIME part identifier within the message.
Image width in pixels. Present when thumbnail dimensions are available.
Email IDs of recipients. Present for huge attachment type only.
Base64-encoded JPEG thumbnail (data URI). Present for image attachments with thumbnail data.
True when this attachment belongs to a comment.
File size in bytes (long as string).
Preview engine file ID for document previews. Present when set.
MIME type or file type identifier of the attachment.
File extension derived from the file name (e.g. 'pdf', 'png').
Comment ID this attachment belongs to. Present when isCommentAttachment is true.
File name of the attachment.
Application ID for cloud attachments. Present when set.
True when the comment was submitted as rich text.
Link preview data embedded in the comment.
Show Sub-Attributes
Title of the linked page.
Video URL if the link is a video.
Description of the linked page.
Preview image URLs.
URL of the linked page.
Embeddable HTML content for the link preview.
Tags associated with the link.
Raw rich-text (HTML) content. Present when RTF is true.
Plain-text content of the comment.
True when RTFText has been sanitized server-side.
Opaque token to retrieve the next page of comments. Absent when there are no more results.
Opaque token to retrieve the previous page of comments. Present when start > 0.
Unique identifier for the request, useful for support and tracing.
Request status code and description (200 on success).
{
"code": 200,
"description": "OK"
}Show Sub-Attributes
HTTP-style numeric status code returned by the API (e.g. 200 for success).
Human-readable text describing the outcome of the request.
- HTTP code 400
Response Body - application/json
Standard error envelope returned for failed requests. Exactly one of 'error' (single error) or 'errors' (multiple validation errors) is present.
Show Sub-Attributes
Unique identifier of the request, useful for support and tracing.
Details of a single error, present when the request fails with one error.
{
"errorMessage": "The 'view' path parameter must be one of: all, unread, unassigned, assigned, archived, spam, trash.",
"errorCode": "INVALID_INPUT",
"locationType": "pathParam",
"location": "view"
}Show Sub-Attributes
Human-readable description of the error.
Application-level error code. INVALID_INPUT for client-side failures (400, 401, 403, 404); INTERNAL_SERVER_ERROR for unexpected server failures (500).
Where the offending input was supplied. Omitted when 'location' is omitted.
Name of the path parameter, query parameter or request body field that caused the error. Omitted when the error is not tied to a specific input.
List of errors returned when a request fails validation on multiple parameters.
Show Sub-Attributes
Details of a single error. 'location' and 'locationType' are present only when the error is attributable to a specific input.
Show Sub-Attributes
Human-readable description of the error.
Application-level error code. INVALID_INPUT for client-side failures (400, 401, 403, 404); INTERNAL_SERVER_ERROR for unexpected server failures (500).
Where the offending input was supplied. Omitted when 'location' is omitted.
Name of the path parameter, query parameter or request body field that caused the error. Omitted when the error is not tied to a specific input.
HTTP-like status code and human-readable description of the error.
{
"code": 200,
"description": "OK"
}Show Sub-Attributes
HTTP-style numeric status code returned by the API (e.g. 200 for success).
Human-readable text describing the outcome of the request.
- HTTP code 401
Response Body - application/json
Standard error envelope returned for failed requests. Exactly one of 'error' (single error) or 'errors' (multiple validation errors) is present.
Show Sub-Attributes
Unique identifier of the request, useful for support and tracing.
Details of a single error, present when the request fails with one error.
{
"errorMessage": "The 'view' path parameter must be one of: all, unread, unassigned, assigned, archived, spam, trash.",
"errorCode": "INVALID_INPUT",
"locationType": "pathParam",
"location": "view"
}Show Sub-Attributes
Human-readable description of the error.
Application-level error code. INVALID_INPUT for client-side failures (400, 401, 403, 404); INTERNAL_SERVER_ERROR for unexpected server failures (500).
Where the offending input was supplied. Omitted when 'location' is omitted.
Name of the path parameter, query parameter or request body field that caused the error. Omitted when the error is not tied to a specific input.
List of errors returned when a request fails validation on multiple parameters.
Show Sub-Attributes
Details of a single error. 'location' and 'locationType' are present only when the error is attributable to a specific input.
Show Sub-Attributes
Human-readable description of the error.
Application-level error code. INVALID_INPUT for client-side failures (400, 401, 403, 404); INTERNAL_SERVER_ERROR for unexpected server failures (500).
Where the offending input was supplied. Omitted when 'location' is omitted.
Name of the path parameter, query parameter or request body field that caused the error. Omitted when the error is not tied to a specific input.
HTTP-like status code and human-readable description of the error.
{
"code": 200,
"description": "OK"
}Show Sub-Attributes
HTTP-style numeric status code returned by the API (e.g. 200 for success).
Human-readable text describing the outcome of the request.
- HTTP code 403
Response Body - application/json
Standard error envelope returned for failed requests. Exactly one of 'error' (single error) or 'errors' (multiple validation errors) is present.
Show Sub-Attributes
Unique identifier of the request, useful for support and tracing.
Details of a single error, present when the request fails with one error.
{
"errorMessage": "The 'view' path parameter must be one of: all, unread, unassigned, assigned, archived, spam, trash.",
"errorCode": "INVALID_INPUT",
"locationType": "pathParam",
"location": "view"
}Show Sub-Attributes
Human-readable description of the error.
Application-level error code. INVALID_INPUT for client-side failures (400, 401, 403, 404); INTERNAL_SERVER_ERROR for unexpected server failures (500).
Where the offending input was supplied. Omitted when 'location' is omitted.
Name of the path parameter, query parameter or request body field that caused the error. Omitted when the error is not tied to a specific input.
List of errors returned when a request fails validation on multiple parameters.
Show Sub-Attributes
Details of a single error. 'location' and 'locationType' are present only when the error is attributable to a specific input.
Show Sub-Attributes
Human-readable description of the error.
Application-level error code. INVALID_INPUT for client-side failures (400, 401, 403, 404); INTERNAL_SERVER_ERROR for unexpected server failures (500).
Where the offending input was supplied. Omitted when 'location' is omitted.
Name of the path parameter, query parameter or request body field that caused the error. Omitted when the error is not tied to a specific input.
HTTP-like status code and human-readable description of the error.
{
"code": 200,
"description": "OK"
}Show Sub-Attributes
HTTP-style numeric status code returned by the API (e.g. 200 for success).
Human-readable text describing the outcome of the request.
- HTTP code 404
Response Body - application/json
Standard error envelope returned for failed requests. Exactly one of 'error' (single error) or 'errors' (multiple validation errors) is present.
Show Sub-Attributes
Unique identifier of the request, useful for support and tracing.
Details of a single error, present when the request fails with one error.
{
"errorMessage": "The 'view' path parameter must be one of: all, unread, unassigned, assigned, archived, spam, trash.",
"errorCode": "INVALID_INPUT",
"locationType": "pathParam",
"location": "view"
}Show Sub-Attributes
Human-readable description of the error.
Application-level error code. INVALID_INPUT for client-side failures (400, 401, 403, 404); INTERNAL_SERVER_ERROR for unexpected server failures (500).
Where the offending input was supplied. Omitted when 'location' is omitted.
Name of the path parameter, query parameter or request body field that caused the error. Omitted when the error is not tied to a specific input.
List of errors returned when a request fails validation on multiple parameters.
Show Sub-Attributes
Details of a single error. 'location' and 'locationType' are present only when the error is attributable to a specific input.
Show Sub-Attributes
Human-readable description of the error.
Application-level error code. INVALID_INPUT for client-side failures (400, 401, 403, 404); INTERNAL_SERVER_ERROR for unexpected server failures (500).
Where the offending input was supplied. Omitted when 'location' is omitted.
Name of the path parameter, query parameter or request body field that caused the error. Omitted when the error is not tied to a specific input.
HTTP-like status code and human-readable description of the error.
{
"code": 200,
"description": "OK"
}Show Sub-Attributes
HTTP-style numeric status code returned by the API (e.g. 200 for success).
Human-readable text describing the outcome of the request.
- HTTP code 429
Response Body - application/json
Standard error envelope returned for failed requests. Exactly one of 'error' (single error) or 'errors' (multiple validation errors) is present.
Show Sub-Attributes
Unique identifier of the request, useful for support and tracing.
Details of a single error, present when the request fails with one error.
{
"errorMessage": "The 'view' path parameter must be one of: all, unread, unassigned, assigned, archived, spam, trash.",
"errorCode": "INVALID_INPUT",
"locationType": "pathParam",
"location": "view"
}Show Sub-Attributes
Human-readable description of the error.
Application-level error code. INVALID_INPUT for client-side failures (400, 401, 403, 404); INTERNAL_SERVER_ERROR for unexpected server failures (500).
Where the offending input was supplied. Omitted when 'location' is omitted.
Name of the path parameter, query parameter or request body field that caused the error. Omitted when the error is not tied to a specific input.
List of errors returned when a request fails validation on multiple parameters.
Show Sub-Attributes
Details of a single error. 'location' and 'locationType' are present only when the error is attributable to a specific input.
Show Sub-Attributes
Human-readable description of the error.
Application-level error code. INVALID_INPUT for client-side failures (400, 401, 403, 404); INTERNAL_SERVER_ERROR for unexpected server failures (500).
Where the offending input was supplied. Omitted when 'location' is omitted.
Name of the path parameter, query parameter or request body field that caused the error. Omitted when the error is not tied to a specific input.
HTTP-like status code and human-readable description of the error.
{
"code": 200,
"description": "OK"
}Show Sub-Attributes
HTTP-style numeric status code returned by the API (e.g. 200 for success).
Human-readable text describing the outcome of the request.
- HTTP code 500
Response Body - application/json
Standard error envelope returned for failed requests. Exactly one of 'error' (single error) or 'errors' (multiple validation errors) is present.
Show Sub-Attributes
Unique identifier of the request, useful for support and tracing.
Details of a single error, present when the request fails with one error.
{
"errorMessage": "The 'view' path parameter must be one of: all, unread, unassigned, assigned, archived, spam, trash.",
"errorCode": "INVALID_INPUT",
"locationType": "pathParam",
"location": "view"
}Show Sub-Attributes
Human-readable description of the error.
Application-level error code. INVALID_INPUT for client-side failures (400, 401, 403, 404); INTERNAL_SERVER_ERROR for unexpected server failures (500).
Where the offending input was supplied. Omitted when 'location' is omitted.
Name of the path parameter, query parameter or request body field that caused the error. Omitted when the error is not tied to a specific input.
List of errors returned when a request fails validation on multiple parameters.
Show Sub-Attributes
Details of a single error. 'location' and 'locationType' are present only when the error is attributable to a specific input.
Show Sub-Attributes
Human-readable description of the error.
Application-level error code. INVALID_INPUT for client-side failures (400, 401, 403, 404); INTERNAL_SERVER_ERROR for unexpected server failures (500).
Where the offending input was supplied. Omitted when 'location' is omitted.
Name of the path parameter, query parameter or request body field that caused the error. Omitted when the error is not tied to a specific input.
HTTP-like status code and human-readable description of the error.
{
"code": 200,
"description": "OK"
}Show Sub-Attributes
HTTP-style numeric status code returned by the API (e.g. 200 for success).
Human-readable text describing the outcome of the request.
Sample Response: HTTP 200
{
"data": {
"userInfo": {
"600001": "Alice Johnson"
},
"comments": [
{
"activity": {
"reminders": [
"7001234567890"
],
"likesCount": 1,
"likedBy": [
"600002"
],
"tags": [
{
"from": 0,
"to": 20,
"text": "Processed the refund",
"type": "QUOTE"
}
]
},
"timestamps": {
"createdAt": "1746173400000",
"lastModifiedAt": "1746173400000"
},
"commentAuthor": {
"authorName": "Alice Johnson",
"authorId": "600001"
},
"comment": {
"commentId": "2001234567890",
"user": true,
"messageVia": "web"
},
"state": {
"hasPrivateComments": false,
"isPrivate": false,
"liked": false,
"isPrivateToPost": false
},
"content": {
"RTF": false,
"text": "Processed the refund. Customer should see it in 3-5 business days.",
"RTFText_sanitized": false
}
}
],
"nextPageToken": "eyJzdGFydElkIjoiMjAwMTIzNDU2Nzg5MCJ9gvterghHdrRg56=",
"previousPageToken": "hiuJzdGFydCI6MTAsIfrhuYuybUCI6MTc0NjE3MjfhruiHUBu8="
},
"requestId": "zmreq-abc12345-def6-7890",
"status": {
"code": 200,
"description": "OK"
}
}
Sample Response: HTTP 400
{
"requestId": "zmreq-abc12345-def6-7890",
"error": {
"errorMessage": "The 'limit' query parameter must be an integer between 1 and 200.",
"errorCode": "INVALID_INPUT",
"locationType": "queryParam",
"location": "limit"
},
"status": {
"code": 400,
"description": "Bad Request"
}
}
Sample Response: HTTP 401
{
"requestId": "zmreq-abc12345-def6-7890",
"error": {
"errorMessage": "The OAuth access token is missing, malformed or has expired.",
"errorCode": "INVALID_INPUT"
},
"status": {
"code": 401,
"description": "Unauthorized"
}
}
Sample Response: HTTP 403
{
"requestId": "zmreq-abc12345-def6-7890",
"error": {
"errorMessage": "The authenticated user does not have permission to perform this operation on this shared mailbox.",
"errorCode": "INVALID_INPUT"
},
"status": {
"code": 403,
"description": "Forbidden"
}
}
Sample Response: HTTP 404
{
"requestId": "zmreq-abc12345-def6-7890",
"error": {
"errorMessage": "Message '1001234567890' was not found in this shared mailbox.",
"errorCode": "INVALID_INPUT"
},
"status": {
"code": 404,
"description": "Not Found"
}
}
Sample Response: HTTP 429
{
"requestId": "zmreq-abc12345-def6-7890",
"error": {
"errorMessage": "The rate limit for this API has been exceeded. Retry after the lock period has elapsed.",
"errorCode": "INVALID_INPUT"
},
"status": {
"code": 429,
"description": "Too Many Requests"
}
}
Sample Response: HTTP 500
{
"requestId": "zmreq-abc12345-def6-7890",
"error": {
"errorMessage": "Something went wrong. Please try again later.",
"errorCode": "INTERNAL_SERVER_ERROR"
},
"status": {
"code": 500,
"description": "Internal Server Error"
}
}
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.