1 line
213 KiB
JSON
1 line
213 KiB
JSON
|
{"success":true,"data":{"web":[{"url":"https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/get-hold-message-list/","title":"Get Hold Message List - API and Integrations | Mimecast","description":"This API endpoint can be used to get information about held messages, including the reason, hold level, sender and recipients.","position":1,"markdown":"**In this guide:**\n\n- [Description](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/get-hold-message-list/#description)\n- [Pre-requisites](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/get-hold-message-list/#pre-requisites)\n- [URI](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/get-hold-message-list/#uri)\n- [Request Headers](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/get-hold-message-list/#request-headers)\n- [Request Body](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/get-hold-message-list/#request-body)\n- [Response](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/get-hold-message-list/#response)\n- [Sample Code](https://integrations.mimecast.com/documentation/endpoint-reference/message-queues/get-hold-message-list/#sample-code)\n\n#### Description\n\nThis API endpoint can be used to get information about held messages, including the reason, hold level, sender and recipients. The ID can be used to act on a message using the Release Message or Reject Message API endpoints.\n\n#### Pre-requisites\n\n- In order to successfully use this endpoint the logged in user must be a Mimecast administrator with at least the **Account \\| Dashboard \\| Read** permission.\n\n#### URI\n\nTo use this endpoint you send a POST request to:\n\n- /api/gateway/get-hold-message-list\n\n#### Request Headers\n\nThe following request headers must be included in your request:\n\n| **Field** | **Description** |\n| --- | --- |\n| Authorization | Please see the [Authorization](https://integrations.mimecast.com/documentation/api-overview/authorization/) guide for more information on building the Authorization header. |\n| x-mc-req-id | A randomly generated GUID, for example,<br>```<br>8578FCFC-A305-4D9A-99CB-F4D5ECEFE297<br>``` |\n| x-mc-app-id | The Application ID provided with your Registered API Application. |\n| x-mc-date | The current date and time in the following format, for example,<br>```<br>Tue, 24 Nov 2015 12:50:11 UTC<br>``` |\n\n#### Request Body\n\n```\n\n{\n\n \"data\": [\\\n\\\n {\\\n\\\n \"admin\": true,\\\n\\\n \"start\": \"2015-11-16T14:49:18+0000\",\\\n\\\n \"searchBy\": {\\\n\\\n \"fieldName\": \"String\",\\\n\\\n \"value\": \"String\"\\\n\\\n },\\\n\\\n \"end\": \"2015-11-16T14:49:18+0000\"\\\n\\\n }\\\n\\\n ]\n\n}\n```\n\n##### data\n\n| **Field** | **Type** | **Required** | **Description** |\n| --- | --- | --- | --- |\n| admin | Boolean | Optional | Level of results to return. If false, only results for the currenlty authenticated user will be returned. If true, held messages for all recipients will be returned. The default value is false. |\n| searchBy | Object | Optional | Object data used to filter results |\n| start | Date String | Optional | The date and time of the earliest message to return, in the following format, 2011-12-03T10:15:30+0000 |\n| end | Date String | Optional | The date and time of the latest message to return, in the following format, 2011-12-03T10:15:30+0000 |\n\n##### searchBy\n\n| **Field** | **Type** | **Required** | **Description** |\n| --- | --- | --- | --- |\n| value | String | Optional | The text used to filter results |\n| fieldName | String | Optional | Message fields to filter based on. Possible values are: all, subject, sender, recipient, reason\\_code |\n\n#### Response\n\n```\n\n{\n\n \"fail\": [],\n\n \"meta\": {\n\n \"status\": 200\n\n },\n\n \"data\": [\\\n\\\n {\\\n\\\n \"dateReceived\": \"String\",\\\n\\\n \"reason\": \"String\",\\\n\\\n \"reasonCode\": \"String\",\\\n\\\n
|