• Share
    • Twitter
    • LinkedIn
    • Facebook
    • Email
  • Feedback
  • Edit
Show / Hide Table of Contents

POST Agents/EMail/MarkAsReadFromServerIdentifiers

Some tooltip text!
• 2 minutes to read
 • 2 minutes to read
POST /api/v1/Agents/EMail/MarkAsReadFromServerIdentifiers

Mark one or more e-mails as (un)read

NsApiSlow threshold: 5000 ms.

Online Restricted: ## The EMail agent is not available in Online by default. Access must be requested specifically when app is registered.

Query String Parameters

Parameter Name Type Description
$select string Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.
POST /api/v1/Agents/EMail/MarkAsReadFromServerIdentifiers?$select=name,department,category/id

Request Headers

Parameter Name Description
Authorization Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Content-Type Content-type of the request body: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, application/json-patch+json, application/merge-patch+json
Accept Content-type(s) you would like the response in:
SO-AppToken The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Request Body: request

ConnectionInfo, MessageServerIds, Read

Property Name Type Description
ConnectionInfo EMailConnectionInfo All information needed to connect to a mailserver Carrier object for EMailConnectionInfo. Services for the EMailConnectionInfo Carrier is available from the EMail Agent.
MessageServerIds Array
Read Boolean

Response:

No Content

Response Description
204 No Content

Response body: TimeZoneData

Sample request

[!include[sample request](../../samples/agent/request/v1EMailAgent_MarkAsReadFromServerIdentifiers.md)]

Sample response

[!include[sample response](../../samples/agent/response/v1EMailAgent_MarkAsReadFromServerIdentifiers.md)]
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top