Edit a comment

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Updates the content or privacy settings of a specific comment. Only the comment author can edit it. To change a public comment to private, set isPrivate to true and provide privateZuid (the recipient's numeric userId). To remove privacy, set isPrivate to false.

Request URL

https://mail.zoho.com/api/v2/sharedmailbox/{mailboxIdentifier}/messages/{messageId}/comments/{commentId} 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

ZohoMail.messages.UPDATECopied!
(or)
ZohoMail.messages.ALLCopied!

Request Parameters

- Path Parameters

mailboxIdentifierstringMandatory

Email address or numeric zgid (group ID) of the shared mailbox group.

Example
support@zylker.com
Maximum Length :256Copied!
messageIdstring(matches: ^[0-9]+$)Mandatory

Numeric ID of the parent message (long as string).

Example
1001234567890
Maximum Length :19Copied!
commentIdstring(matches: ^[0-9]+$)Mandatory

Numeric ID of the comment to edit (long as string).

Example
2001234567890
Maximum Length :19Copied!

- Query Parameters

fieldsstringOptional

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.

Example
messageId,title,fromAddress,toAddress,createdAt,unread
Maximum Length :1000Copied!

- Request Body

application/json
JSON Object

Request body for editing an existing comment on a shared mailbox message. Extends CommentRequest with delAttachIds for removing attachments during edit.

Show Sub-Attributes
entityAttachmentsJSON Array[object]Optional

Existing entity attachment references to include.

Range :[0 .. 25][0 .. 25]
Show Sub-Attributes
estringMandatory

Encrypted attachment reference token of the source attachment.

streamsViewstringOptional

Streams view flag. Must be 'Notes', 'true', or 'false'.

Allowed Values :
Show Values ▾
NotesCopied!
trueCopied!
falseCopied!
Copied!Copy all as JSON Array
shIdstringOptional

Numeric share ID of the attachment (long as string).

groupIdstringOptional

Numeric group ID (zgid) the attachment belongs to (long as string).

IdstringMandatory

Numeric ID of the source entity the attachment is copied from (long as string).

ftintegerMandatory

File type code of the source attachment.

uniqueIdstringOptional

Unique identifier of the attachment.

nstringOptional

File name of the attachment.

Maximum Length :1000Copied!
etintegerMandatory

Entity type code of the source attachment.

rtfbooleanOptional

When true, content is treated as rich text format.

mentionsJSON Array[object]Optional

List of user mentions in the comment.

Range :[0 .. 100][0 .. 100]
Show Sub-Attributes
offsettextsintegerOptional

Offset marker associated with the mention text.

useridsstringOptional

Numeric user ID (ZUID) of the mentioned user (long as string).

offsetendsintegerOptional

End character offset of the mention within the comment text.

offsetstartsintegerOptional

Start character offset of the mention within the comment text.

delAttachIdsarray[string]Optional

Numeric IDs of attachments to remove from the comment during this edit (long as string each).

Range :[0 .. 25][0 .. 25]
replyTostringOptional

ID of the comment being replied to, for threaded replies.

Maximum Length :50Copied!
temporaryAttachmentsJSON Array[object]Optional

Temporary attachment tokens to attach to the comment.

Range :[0 .. 25][0 .. 25]
Show Sub-Attributes
sizeintegerOptional

Size of the uploaded file in bytes.

fPstringMandatory

Temporary file path token returned by the file upload API.

Maximum Length :1530Copied!
sNstringMandatory

Store name returned by the file upload API.

nstringOptional

File name of the attachment.

Maximum Length :1000Copied!
isPrivatebooleanOptional

When true, the comment is a private reply visible only to the sender and the user identified by privateZuid.

contentstringOptional

Updated HTML or plain-text content of the comment.

isPrivateToPostbooleanOptional

When true, the comment is private to the post author.

privateZuidstringOptional

Numeric user ID of the private reply recipient (long as string). Required when isPrivate is true.

Sample Request

Curl
Java
Python
Deluge
Php
Copied!
curl --request PUT \
  --url 'https://mail.zoho.com/api/v2/sharedmailbox/support@zylker.com/messages/1001234567890/comments/2001234567890?fields=messageId%2Ctitle%2CfromAddress%2CtoAddress%2CcreatedAt%2Cunread' \
  --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
  --header 'content-type: application/json' \
  --data '{"content":"Processed the refund. Customer should see it within 3-5 business days. Apologies for the inconvenience."}'

Sample Request Body

Copied!
  {
    "content": "Processed the refund. Customer should see it within 3-5 business days. Apologies for the inconvenience."
  }
                
▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object

Response envelope for a single shared mailbox comment.

Show Sub-Attributes
dataJSON Object

The comment details.

Example
{
  "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
  }
}
Show Sub-Attributes
integrationInfosJSON Object

Integration metadata linked to the comment. Present when the comment was created via a Zoho integration.

Show Sub-Attributes
idstring

ID of the integrated entity (long as string).

timestring

Timestamp of the integration event (long as string).

typestring

Integration relation type (e.g. 'CRM', 'DESK').

titlestring

Display title from the integrated source.

infostring

Additional metadata from the integrated source.

privateJSON Object

Private replies on this comment. Present when includePrivateComments=true and private replies exist.

Show Sub-Attributes
privateCommentsJSON Array

List of private replies on this comment.

Show Sub-Attributes
JSON Object

A private comment visible only to the sender and one recipient, as returned by buildPrivateCommentJSON.

Show Sub-Attributes
createdAtstring

ISO 8601 creation time of the private comment.

integrationInfosJSON Object

Integration metadata linked to the private comment. Present when the comment has integration data.

Show Sub-Attributes
idstring

ID of the integrated entity (long as string).

timestring

Timestamp of the integration event (long as string).

typestring

Integration relation type (e.g. 'CRM', 'DESK').

titlestring

Display title from the integrated source.

infostring

Additional metadata from the integrated source.

commentAuthorJSON Object

Author of the private comment.

Show Sub-Attributes
authorNamestring

Display name of the author.

authorIdstring

Numeric user ID of the author (long as string).

recipientstring

Numeric user ID of the intended recipient (long as string).

commentIdstring

Unique numeric ID of the private comment (long as string).

isPrivatestring

Always 'true' for private comments.

messageViastring

Always 'REST' for private comments created via API.

contentJSON Object

Content of the private comment.

Show Sub-Attributes
RTFboolean

True when the content is rich text.

RTFTextstring

Raw rich-text (HTML) content. Present when RTF is true.

textstring

Plain-text content.

RTFText_sanitizedboolean

True when RTFText has been sanitized.

activityJSON Object

Social activity and metadata on the comment.

Show Sub-Attributes
remindersarray[string]

Reminder IDs associated with the comment (long as string each). Present when reminders exist.

likesCountinteger

Number of likes on the comment.

likedByarray[string]

Numeric user IDs of users who liked the comment (long as string each). Present when likesCount > 0.

tagsJSON Array[object]

Inline quote tags within the comment text, as offset markers into the comment content.

Show Sub-Attributes
frominteger

Start character offset within the text.

tointeger

End character offset within the text.

textstring

The tagged span of text.

typestring

Tag kind. One of: MENTION, HASHTAG, QUOTE, TWEET_MENTION, LINK.

Allowed Values :
Show Values ▾
MENTIONCopied!
HASHTAGCopied!
QUOTECopied!
TWEET_MENTIONCopied!
LINKCopied!
Copied!Copy all as JSON Array
commentReplyJSON Object

Reply-to context when the comment is a threaded reply to another comment. Present only when replyTo is set.

Show Sub-Attributes
replyToDisplayNamestring

Display name of the parent comment's author.

replyTostring

Comment ID of the parent comment being replied to.

replyToZuidstring

Numeric user ID of the parent comment's author (long as string).

replyContentstring

Text snippet of the parent comment. Present when requested via addlData.

timestampsJSON Object

Timestamps for the comment.

Show Sub-Attributes
createdAtstring

ISO 8601 creation time of the comment.

lastModifiedAtstring

Last modification time in epoch milliseconds (long as string). Present when the comment has been edited.

commentAuthorJSON Object

Author identity of the comment.

Show Sub-Attributes
authorNamestring

Display name of the comment author.

authorIdstring

Numeric user ID of the comment author (long as string).

commentJSON Object

Core comment identity fields.

Show Sub-Attributes
customStatusinteger

Custom status value. Present when > 0.

commentTypeinteger

Numeric type of the comment. Present when > 0.

commentIdstring

Unique numeric ID of the comment (long as string).

externalIdstring

External identifier for migrated or integrated comments.

userboolean

True when posted by a real user (false for auto-generated system comments).

sequenceIdstring

Sequence ID of the comment (long as string). Present when > 0.

messageViastring

Channel through which the comment was posted ('web' or 'mobile').

stateJSON Object

State flags for the comment.

Show Sub-Attributes
hasPrivateCommentsboolean

True when there are private replies visible to the current user.

isPrivateboolean

True when this comment is a private reply to another comment.

likedboolean

True when the current user has liked the comment.

isPrivateToPostboolean

True when this is a private-to-post comment visible only to the message owner.

contentJSON Object

Comment body and media.

Show Sub-Attributes
attachmentsJSON Array

Attachments on the comment. Present when includeAttachments=true.

Show Sub-Attributes
JSON Object

An attachment on a message or comment as returned by AttachmentInfoImpl.toJSONV2 + AttachStoreInfoImpl.toJSONV2. All keys match AttachmentJSONConstantsV2.

Show Sub-Attributes
sourceIdstring

Source namespace/user ID associated with the attachment (long as string).

canBeBleachedboolean

True when the attachment can be sanitized/bleached. Present only when true.

applicationTypeinteger

Application type for cloud attachments. Present when > 0.

attachmentTypeinteger

Attachment type code (e.g. inline, regular, cloud, huge).

attachmentDocumentIdstring

Document ID associated with the attachment for Zoho Docs integration.

attachmentStatusinteger

Attachment status code.

contentIdstring

Content ID for inline (embedded) attachments. Present when set.

openWithDocIdstring

Document ID for open-with integrations. Present when set.

shareTypeinteger

Share type of the attachment.

isPasswordProtectedboolean

True when the attachment is password-protected. Present only when true.

isDeletedboolean

True when the attachment has been deleted. Present only when true.

expiryTypestring

Expiry type for time-limited attachment links. Present when set.

digeststring

Content digest/hash of the attachment. Present when set.

attachmentIdstring

Numeric attachment ID (long as string).

thumbnailHeightinteger

Image height in pixels. Present when thumbnail dimensions are available.

isAttachmentInlineboolean

True when the attachment is inline (embedded in the body).

expiryValuestring

Expiry value for time-limited attachment links. Present when set.

inferredFormatstring

Server-inferred file format when the extension is missing or ambiguous. Present when set.

scanDetailsJSON Object

Virus/malware scan details for the attachment.

Show Sub-Attributes
lastVirusScanTimestampinteger

Epoch timestamp of the last virus scan.

isScanCacheValidboolean

True when the cached scan result is still valid.

isEncryptedScanPerformedboolean

True when an encrypted scan was performed.

scanStatusstring

Result of the virus scan (e.g. 'CLEAN', 'INFECTED').

errorCodeinteger

Scan error code. Present when scanStatus indicates an error.

attachmentEncryptionStatusinteger

Encryption status code of the attachment.

isPreviewAvailableboolean

True when a web preview is available for this attachment.

isThumbnailboolean

True when this is a thumbnail attachment.

attachmentTagsarray[string]

Label/tag IDs associated with the attachment.

attachmentPartIdstring

MIME part identifier within the message.

thumbnailWidthinteger

Image width in pixels. Present when thumbnail dimensions are available.

sharedEmailIdsarray[string]

Email IDs of recipients. Present for huge attachment type only.

thumbnailDatastring

Base64-encoded JPEG thumbnail (data URI). Present for image attachments with thumbnail data.

isCommentAttachmentboolean

True when this attachment belongs to a comment.

attachmentSizestring

File size in bytes (long as string).

previewEngineFileIdstring

Preview engine file ID for document previews. Present when set.

attachmentFileTypestring

MIME type or file type identifier of the attachment.

attachmentFormatstring

File extension derived from the file name (e.g. 'pdf', 'png').

commentIdstring

Comment ID this attachment belongs to. Present when isCommentAttachment is true.

attachmentNamestring

File name of the attachment.

applicationIdstring

Application ID for cloud attachments. Present when set.

RTFboolean

True when the comment was submitted as rich text.

RTFTextstring

Raw rich-text (HTML) content. Present when RTF is true.

textstring

Plain-text content of the comment.

RTFText_sanitizedboolean

True when RTFText has been sanitized server-side.

requestIdstring

Unique identifier for the request, useful for support and tracing.

statusJSON Object

Request status code and description (200 on success).

Example
{
  "code": 200,
  "description": "OK"
}
Show Sub-Attributes
codeinteger

HTTP-style numeric status code returned by the API (e.g. 200 for success).

descriptionstring

Human-readable text describing the outcome of the request.

- HTTP code 400

Response Body - application/json
JSON Object

Standard error envelope returned for failed requests. Exactly one of 'error' (single error) or 'errors' (multiple validation errors) is present.

Show Sub-Attributes
requestIdstring

Unique identifier of the request, useful for support and tracing.

errorJSON Object

Details of a single error, present when the request fails with one error.

Example
{
  "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
errorMessagestring

Human-readable description of the error.

errorCodestring

Application-level error code. INVALID_INPUT for client-side failures (400, 401, 403, 404); INTERNAL_SERVER_ERROR for unexpected server failures (500).

locationTypestring

Where the offending input was supplied. Omitted when 'location' is omitted.

Allowed Values :
Show Values ▾
pathParamCopied!
queryParamCopied!
requestBodyCopied!
headerCopied!
Copied!Copy all as JSON Array
locationstring

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.

errorsJSON Array

List of errors returned when a request fails validation on multiple parameters.

Show Sub-Attributes
JSON Object

Details of a single error. 'location' and 'locationType' are present only when the error is attributable to a specific input.

Show Sub-Attributes
errorMessagestring

Human-readable description of the error.

errorCodestring

Application-level error code. INVALID_INPUT for client-side failures (400, 401, 403, 404); INTERNAL_SERVER_ERROR for unexpected server failures (500).

locationTypestring

Where the offending input was supplied. Omitted when 'location' is omitted.

Allowed Values :
Show Values ▾
pathParamCopied!
queryParamCopied!
requestBodyCopied!
headerCopied!
Copied!Copy all as JSON Array
locationstring

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.

statusJSON Object

HTTP-like status code and human-readable description of the error.

Example
{
  "code": 200,
  "description": "OK"
}
Show Sub-Attributes
codeinteger

HTTP-style numeric status code returned by the API (e.g. 200 for success).

descriptionstring

Human-readable text describing the outcome of the request.

- HTTP code 401

Response Body - application/json
JSON Object

Standard error envelope returned for failed requests. Exactly one of 'error' (single error) or 'errors' (multiple validation errors) is present.

Show Sub-Attributes
requestIdstring

Unique identifier of the request, useful for support and tracing.

errorJSON Object

Details of a single error, present when the request fails with one error.

Example
{
  "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
errorMessagestring

Human-readable description of the error.

errorCodestring

Application-level error code. INVALID_INPUT for client-side failures (400, 401, 403, 404); INTERNAL_SERVER_ERROR for unexpected server failures (500).

locationTypestring

Where the offending input was supplied. Omitted when 'location' is omitted.

Allowed Values :
Show Values ▾
pathParamCopied!
queryParamCopied!
requestBodyCopied!
headerCopied!
Copied!Copy all as JSON Array
locationstring

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.

errorsJSON Array

List of errors returned when a request fails validation on multiple parameters.

Show Sub-Attributes
JSON Object

Details of a single error. 'location' and 'locationType' are present only when the error is attributable to a specific input.

Show Sub-Attributes
errorMessagestring

Human-readable description of the error.

errorCodestring

Application-level error code. INVALID_INPUT for client-side failures (400, 401, 403, 404); INTERNAL_SERVER_ERROR for unexpected server failures (500).

locationTypestring

Where the offending input was supplied. Omitted when 'location' is omitted.

Allowed Values :
Show Values ▾
pathParamCopied!
queryParamCopied!
requestBodyCopied!
headerCopied!
Copied!Copy all as JSON Array
locationstring

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.

statusJSON Object

HTTP-like status code and human-readable description of the error.

Example
{
  "code": 200,
  "description": "OK"
}
Show Sub-Attributes
codeinteger

HTTP-style numeric status code returned by the API (e.g. 200 for success).

descriptionstring

Human-readable text describing the outcome of the request.

- HTTP code 403

Response Body - application/json
JSON Object

Standard error envelope returned for failed requests. Exactly one of 'error' (single error) or 'errors' (multiple validation errors) is present.

Show Sub-Attributes
requestIdstring

Unique identifier of the request, useful for support and tracing.

errorJSON Object

Details of a single error, present when the request fails with one error.

Example
{
  "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
errorMessagestring

Human-readable description of the error.

errorCodestring

Application-level error code. INVALID_INPUT for client-side failures (400, 401, 403, 404); INTERNAL_SERVER_ERROR for unexpected server failures (500).

locationTypestring

Where the offending input was supplied. Omitted when 'location' is omitted.

Allowed Values :
Show Values ▾
pathParamCopied!
queryParamCopied!
requestBodyCopied!
headerCopied!
Copied!Copy all as JSON Array
locationstring

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.

errorsJSON Array

List of errors returned when a request fails validation on multiple parameters.

Show Sub-Attributes
JSON Object

Details of a single error. 'location' and 'locationType' are present only when the error is attributable to a specific input.

Show Sub-Attributes
errorMessagestring

Human-readable description of the error.

errorCodestring

Application-level error code. INVALID_INPUT for client-side failures (400, 401, 403, 404); INTERNAL_SERVER_ERROR for unexpected server failures (500).

locationTypestring

Where the offending input was supplied. Omitted when 'location' is omitted.

Allowed Values :
Show Values ▾
pathParamCopied!
queryParamCopied!
requestBodyCopied!
headerCopied!
Copied!Copy all as JSON Array
locationstring

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.

statusJSON Object

HTTP-like status code and human-readable description of the error.

Example
{
  "code": 200,
  "description": "OK"
}
Show Sub-Attributes
codeinteger

HTTP-style numeric status code returned by the API (e.g. 200 for success).

descriptionstring

Human-readable text describing the outcome of the request.

- HTTP code 404

Response Body - application/json
JSON Object

Standard error envelope returned for failed requests. Exactly one of 'error' (single error) or 'errors' (multiple validation errors) is present.

Show Sub-Attributes
requestIdstring

Unique identifier of the request, useful for support and tracing.

errorJSON Object

Details of a single error, present when the request fails with one error.

Example
{
  "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
errorMessagestring

Human-readable description of the error.

errorCodestring

Application-level error code. INVALID_INPUT for client-side failures (400, 401, 403, 404); INTERNAL_SERVER_ERROR for unexpected server failures (500).

locationTypestring

Where the offending input was supplied. Omitted when 'location' is omitted.

Allowed Values :
Show Values ▾
pathParamCopied!
queryParamCopied!
requestBodyCopied!
headerCopied!
Copied!Copy all as JSON Array
locationstring

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.

errorsJSON Array

List of errors returned when a request fails validation on multiple parameters.

Show Sub-Attributes
JSON Object

Details of a single error. 'location' and 'locationType' are present only when the error is attributable to a specific input.

Show Sub-Attributes
errorMessagestring

Human-readable description of the error.

errorCodestring

Application-level error code. INVALID_INPUT for client-side failures (400, 401, 403, 404); INTERNAL_SERVER_ERROR for unexpected server failures (500).

locationTypestring

Where the offending input was supplied. Omitted when 'location' is omitted.

Allowed Values :
Show Values ▾
pathParamCopied!
queryParamCopied!
requestBodyCopied!
headerCopied!
Copied!Copy all as JSON Array
locationstring

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.

statusJSON Object

HTTP-like status code and human-readable description of the error.

Example
{
  "code": 200,
  "description": "OK"
}
Show Sub-Attributes
codeinteger

HTTP-style numeric status code returned by the API (e.g. 200 for success).

descriptionstring

Human-readable text describing the outcome of the request.

- HTTP code 429

Response Body - application/json
JSON Object

Standard error envelope returned for failed requests. Exactly one of 'error' (single error) or 'errors' (multiple validation errors) is present.

Show Sub-Attributes
requestIdstring

Unique identifier of the request, useful for support and tracing.

errorJSON Object

Details of a single error, present when the request fails with one error.

Example
{
  "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
errorMessagestring

Human-readable description of the error.

errorCodestring

Application-level error code. INVALID_INPUT for client-side failures (400, 401, 403, 404); INTERNAL_SERVER_ERROR for unexpected server failures (500).

locationTypestring

Where the offending input was supplied. Omitted when 'location' is omitted.

Allowed Values :
Show Values ▾
pathParamCopied!
queryParamCopied!
requestBodyCopied!
headerCopied!
Copied!Copy all as JSON Array
locationstring

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.

errorsJSON Array

List of errors returned when a request fails validation on multiple parameters.

Show Sub-Attributes
JSON Object

Details of a single error. 'location' and 'locationType' are present only when the error is attributable to a specific input.

Show Sub-Attributes
errorMessagestring

Human-readable description of the error.

errorCodestring

Application-level error code. INVALID_INPUT for client-side failures (400, 401, 403, 404); INTERNAL_SERVER_ERROR for unexpected server failures (500).

locationTypestring

Where the offending input was supplied. Omitted when 'location' is omitted.

Allowed Values :
Show Values ▾
pathParamCopied!
queryParamCopied!
requestBodyCopied!
headerCopied!
Copied!Copy all as JSON Array
locationstring

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.

statusJSON Object

HTTP-like status code and human-readable description of the error.

Example
{
  "code": 200,
  "description": "OK"
}
Show Sub-Attributes
codeinteger

HTTP-style numeric status code returned by the API (e.g. 200 for success).

descriptionstring

Human-readable text describing the outcome of the request.

- HTTP code 500

Response Body - application/json
JSON Object

Standard error envelope returned for failed requests. Exactly one of 'error' (single error) or 'errors' (multiple validation errors) is present.

Show Sub-Attributes
requestIdstring

Unique identifier of the request, useful for support and tracing.

errorJSON Object

Details of a single error, present when the request fails with one error.

Example
{
  "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
errorMessagestring

Human-readable description of the error.

errorCodestring

Application-level error code. INVALID_INPUT for client-side failures (400, 401, 403, 404); INTERNAL_SERVER_ERROR for unexpected server failures (500).

locationTypestring

Where the offending input was supplied. Omitted when 'location' is omitted.

Allowed Values :
Show Values ▾
pathParamCopied!
queryParamCopied!
requestBodyCopied!
headerCopied!
Copied!Copy all as JSON Array
locationstring

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.

errorsJSON Array

List of errors returned when a request fails validation on multiple parameters.

Show Sub-Attributes
JSON Object

Details of a single error. 'location' and 'locationType' are present only when the error is attributable to a specific input.

Show Sub-Attributes
errorMessagestring

Human-readable description of the error.

errorCodestring

Application-level error code. INVALID_INPUT for client-side failures (400, 401, 403, 404); INTERNAL_SERVER_ERROR for unexpected server failures (500).

locationTypestring

Where the offending input was supplied. Omitted when 'location' is omitted.

Allowed Values :
Show Values ▾
pathParamCopied!
queryParamCopied!
requestBodyCopied!
headerCopied!
Copied!Copy all as JSON Array
locationstring

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.

statusJSON Object

HTTP-like status code and human-readable description of the error.

Example
{
  "code": 200,
  "description": "OK"
}
Show Sub-Attributes
codeinteger

HTTP-style numeric status code returned by the API (e.g. 200 for success).

descriptionstring

Human-readable text describing the outcome of the request.

Sample Response: HTTP 200

Copied!
  {
    "data": {
      "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
      }
    },
    "requestId": "zmreq-abc12345-def6-7890",
    "status": {
      "code": 200,
      "description": "OK"
    }
  }
                
▼ Show full

Sample Response: HTTP 400

Copied!
  {
    "requestId": "zmreq-abc12345-def6-7890",
    "error": {
      "errorMessage": "The 'content' field must not be empty when supplied.",
      "errorCode": "INVALID_INPUT",
      "locationType": "requestBody",
      "location": "content"
    },
    "status": {
      "code": 400,
      "description": "Bad Request"
    }
  }
                
▼ Show full

Sample Response: HTTP 401

Copied!
  {
    "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"
    }
  }
                
▼ Show full

Sample Response: HTTP 403

Copied!
  {
    "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"
    }
  }
                
▼ Show full

Sample Response: HTTP 404

Copied!
  {
    "requestId": "zmreq-abc12345-def6-7890",
    "error": {
      "errorMessage": "Comment '2001234567890' was not found on message '1001234567890'.",
      "errorCode": "INVALID_INPUT"
    },
    "status": {
      "code": 404,
      "description": "Not Found"
    }
  }
                
▼ Show full

Sample Response: HTTP 429

Copied!
  {
    "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"
    }
  }
                
▼ Show full

Sample Response: HTTP 500

Copied!
  {
    "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"
    }
  }
                
▼ Show full