Update message with the Outlook Mail API

Changes a message and returns it: marks it read or unread, flags it, sets its categories or importance, or moves it between Focused and Other. On a draft it also changes subject, body and recipients. Only the fields sent change.

Identifier
outlook_update_message

The request

POST https://connect.reportei.com/api/tools/outlook_update_message/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "message_id": "<message_id>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
message_idstringYesMessage id from List messages, Create draft or the hitId from Search messages.
isReadbooleanNotrue marks the message as read, false as unread.
flagobjectNoFollow-up flag of the message.
categoriesarrayNoCategory names. The list replaces the current one.
importancestringNoImportance of the message.Values: low, normal, high
inferenceClassificationstringNoMoves the message to the Focused or the Other tab of the inbox.Values: focused, other
subjectstringNoSubject. Drafts only.
bodyobjectNoContent of the email. Drafts only. contentType is text or html.
toRecipientsarrayNoRecipients in To, replacing the current ones. Drafts only.
ccRecipientsarrayNoRecipients in Cc, replacing the current ones. Drafts only.
bccRecipientsarrayNoRecipients in Bcc, replacing the current ones. Drafts only.

Supported connections

Your customer connects their Outlook Mail account once, with one of the modes below. The same connection serves every tool of the toolkit.

OAuth with your product's app

You register your product's OAuth app once, with POST /api/merchants/credentials/outlook, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/outlook_update_message. It becomes your agent's tool definition with no conversion.

Other Outlook Mail tools

See all 12 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.