Get a message

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

Returns the full details of a specific message in the shared mailbox, including optional comments, invitees, and attachments.

Request URL

https://mail.zoho.com/api/v2/sharedmailbox/{mailboxIdentifier}/messages/{messageId} 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.READCopied!
(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 message (long as string).

Example
1001234567890
Maximum Length :19Copied!

- Query Parameters

allCommentsbooleanOptional

When true, returns all comments on the message. When false (default), returns only the most recent commentsCount comments.

Example
true
commentsCountintegerOptional

Number of recent comments to include in the response. Defaults to -1. Ignored when allComments is true.

Example
10
includePrivateCommentsbooleanOptional

When true, the response includes private comments on this message: comments posted privately to the message (private-to-post) and private replies on each of the message's comments returned in the response. Private comments are visible only to the sender and the intended recipient. Defaults to false.

Example
false
includeAttachmentsbooleanOptional

When true, attachment data for the message is included in the response. Defaults to false.

Example
true
fieldsstringOptional

Comma-separated fields to include in response. When omitted, all fields are returned. Possible values: messageId, mailSpaceId, entityId, entityType, messageVia, senderId, senderName, latestSenderName, groupId, groupName, isGroup, streamsEnabled, content, title, summary, htmlSummary, fromAddress, toAddress, ccAddress, messageType, isConversation, lastReplyUserId, lastMessageId, sentOnly, folderDetails, displayImage, entitySize, threadId, threadEntities, threadUnreadCount, threadCount, conversationThreadId, timestamps, createdAt, lastModifiedAt, displayDate, displayTime, updatedTime, pinnedTime, draftSentTime, toTimezone, archived, draft, lockInvites, pinned, liked, spam, trash, unread, starred, watching, shared, autoShare, hasAttachments, isOwner, ownerId, accessLevel, accessLevelVsInvitees, subSpaceId, collectionSpace, allowComments, showInvite, showDelete, commentsCount, likesCount, likedBy, inviteesCount, chatlets, mentions, inviteeList, sharedGroups and other fields also.

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

Sample Request

Curl
Java
Python
Deluge
Php
Copied!
curl --request GET \
  --url 'https://mail.zoho.com/api/v2/sharedmailbox/support@zylker.com/messages/1001234567890?allComments=true&commentsCount=10&includePrivateComments=false&includeAttachments=true&fields=messageId%2Ctitle%2CfromAddress%2CtoAddress%2CcreatedAt%2Cunread' \
  --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object

Response envelope for a single shared mailbox message.

Show Sub-Attributes
dataJSON Object

Full message detail including comments and attachments.

Example
{
  "userInfo": {
    "600001": "Alice Johnson",
    "600002": "Bob Smith",
    "600003": "John Doe"
  },
  "comments": {
    "totalComments": 3
  },
  "activity": {
    "likesCount": 1,
    "sharedGroups": [
      {
        "streamsEnabled": true,
        "name": "Support Team",
        "id": "800000002",
        "isGroup": true
      }
    ],
    "inviteesCount": 2,
    "likedBy": [
      "600001"
    ],
    "commentsCount": 3,
    "mentions": [],
    "chatlets": 0,
    "inviteeList": [
      "600001",
      "800000002"
    ]
  },
  "timestamps": {
    "createdAt": "1746172800000",
    "displayTime": "1746172800000",
    "lastModifiedAt": "1746172800000",
    "displayDate": "FRI MAY 02",
    "toTimezone": "IST"
  },
  "thread": {
    "isConversation": false,
    "lastReplyUserId": "-1"
  },
  "message": {
    "messageType": "1",
    "mailSpaceId": "800000001",
    "messageId": "1001234567890",
    "fromAddress": "john.doe@example.com",
    "folderDetails": {
      "folderName": "Inbox",
      "folderId": "800000002"
    },
    "toAddress": "support@zylker.com",
    "messageVia": "mail",
    "entitySize": 4096,
    "content": {
      "summary": "Hi, I placed order #98765 last week and would like to request a refund due to a defective item...",
      "title": "Order #98765 - Refund Request"
    },
    "ccAddress": "Not Provided"
  },
  "labels": {
    "groupLabels": [
      "3001234567890"
    ],
    "userLabels": [
      "3001234567891"
    ],
    "tags": [
      {
        "from": 0,
        "to": 35,
        "text": "Hi, I placed order #98765 last week",
        "type": "QUOTE"
      }
    ]
  },
  "relationships": {
    "associatedTo": [
      {
        "namespaceId": "100000001",
        "entityType": 1,
        "entityId": "1001234567891"
      }
    ],
    "sharedMailIds": [
      "1001234567893"
    ],
    "associatedFrom": [
      {
        "namespaceId": "100000001",
        "entityType": 6,
        "entityId": "1001234567892"
      }
    ]
  },
  "ownership": {
    "accountId": "100000001",
    "assigneeList": [
      "600002"
    ],
    "accessLevel": 2,
    "isOwner": false,
    "accessLevelVsInvitees": {
      "1": [
        "600002"
      ],
      "2": [
        "600004",
        "600005"
      ]
    }
  },
  "sender": {
    "senderId": "600003",
    "senderName": "John Doe",
    "latestSenderName": "John Doe"
  },
  "permissions": {
    "allowComments": true,
    "showDelete": false,
    "showInvite": true
  },
  "state": {
    "shared": false,
    "pinned": false,
    "unread": true,
    "autoShare": false,
    "lockInvites": false,
    "watching": false,
    "liked": false,
    "trash": false,
    "archived": false,
    "starred": false,
    "draft": false,
    "spam": false,
    "hasAttachments": "false",
    "sentOnly": false
  },
  "group": {
    "groupName": "Zylker Support",
    "streamsEnabled": true,
    "groupId": "705000001",
    "isGroup": true
  }
}
Show Sub-Attributes
userInfoJSON Object

Map of ZUID to display name for users referenced in this message. Present when the streams new-flow flag is enabled.

Show Sub-Attributes
{key_name}string
Accepts any additional properties with custom keys
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": {
      "userInfo": {
        "600001": "Alice Johnson",
        "600002": "Bob Smith",
        "600003": "John Doe"
      },
      "comments": {
        "totalComments": 3
      },
      "activity": {
        "likesCount": 1,
        "sharedGroups": [
          {
            "streamsEnabled": true,
            "name": "Support Team",
            "id": "800000002",
            "isGroup": true
          }
        ],
        "inviteesCount": 2,
        "likedBy": [
          "600001"
        ],
        "commentsCount": 3,
        "mentions": [],
        "chatlets": 0,
        "inviteeList": [
          "600001",
          "800000002"
        ]
      },
      "timestamps": {
        "createdAt": "1746172800000",
        "displayTime": "1746172800000",
        "lastModifiedAt": "1746172800000",
        "displayDate": "FRI MAY 02",
        "toTimezone": "IST"
      },
      "thread": {
        "isConversation": false,
        "lastReplyUserId": "-1"
      },
      "message": {
        "messageType": "1",
        "mailSpaceId": "800000001",
        "messageId": "1001234567890",
        "fromAddress": "john.doe@example.com",
        "folderDetails": {
          "folderName": "Inbox",
          "folderId": "800000002"
        },
        "toAddress": "support@zylker.com",
        "messageVia": "mail",
        "entitySize": 4096,
        "content": {
          "summary": "Hi, I placed order #98765 last week and would like to request a refund due to a defective item...",
          "title": "Order #98765 - Refund Request"
        },
        "ccAddress": "Not Provided"
      },
      "labels": {
        "groupLabels": [
          "3001234567890"
        ],
        "userLabels": [
          "3001234567891"
        ],
        "tags": [
          {
            "from": 0,
            "to": 35,
            "text": "Hi, I placed order #98765 last week",
            "type": "QUOTE"
          }
        ]
      },
      "relationships": {
        "associatedTo": [
          {
            "namespaceId": "100000001",
            "entityType": 1,
            "entityId": "1001234567891"
          }
        ],
        "sharedMailIds": [
          "1001234567893"
        ],
        "associatedFrom": [
          {
            "namespaceId": "100000001",
            "entityType": 6,
            "entityId": "1001234567892"
          }
        ]
      },
      "ownership": {
        "accountId": "100000001",
        "assigneeList": [
          "600002"
        ],
        "accessLevel": 2,
        "isOwner": false,
        "accessLevelVsInvitees": {
          "1": [
            "600002"
          ],
          "2": [
            "600004",
            "600005"
          ]
        }
      },
      "sender": {
        "senderId": "600003",
        "senderName": "John Doe",
        "latestSenderName": "John Doe"
      },
      "permissions": {
        "allowComments": true,
        "showDelete": false,
        "showInvite": true
      },
      "state": {
        "shared": false,
        "pinned": false,
        "unread": true,
        "autoShare": false,
        "lockInvites": false,
        "watching": false,
        "liked": false,
        "trash": false,
        "archived": false,
        "starred": false,
        "draft": false,
        "spam": false,
        "hasAttachments": "false",
        "sentOnly": false
      },
      "group": {
        "groupName": "Zylker Support",
        "streamsEnabled": true,
        "groupId": "705000001",
        "isGroup": true
      }
    },
    "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 'messageId' path parameter must be a numeric message ID.",
      "errorCode": "INVALID_INPUT",
      "locationType": "pathParam",
      "location": "messageId"
    },
    "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": "Message '1001234567890' was not found in this shared mailbox.",
      "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