Create draft with the Outlook Mail API
Saves a new email in Drafts without sending it and returns it with its id. Change it with Update message and send it with Send draft, or let the user review and send it from Outlook.
- Identifier
- outlook_create_draft
The request
POST https://connect.reportei.com/api/tools/outlook_create_draft/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"subject": "<subject>"
}
}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
| Parameter | Type | Required | Description |
|---|---|---|---|
| subject | string | No | Subject of the email. |
| body | object | No | Content of the email. contentType is text or html. |
| toRecipients | array | No | Recipients in To. |
| ccRecipients | array | No | Recipients in Cc. |
| bccRecipients | array | No | Recipients in Bcc. |
| importance | string | No | Importance of the email. The default is normal.Values: low, normal, high |
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_create_draft. It becomes your agent's tool definition with no conversion.
Other Outlook Mail tools
- List mail foldersGETLists the mail folders directly under the root of the mailbox, with id, displayName, unreadItemCount and totalItemCount. Child folders are not included, and only the first page comes back. The well-known names inbox, sentitems, drafts, deleteditems, archive and junkemail work as folder ids in the other tools without this call.
- List messagesGETLists the messages of a folder, 10 per page, with subject, from, receivedDateTime, isRead and bodyPreview, the first 255 characters of the body. Only the first page comes back: to reach older messages, use Search messages, which pages with from. Read the full text of one message with Get message.
- Search messagesPOSTSearches the mailbox, attachments included, and returns the hits newest first, up to 25 per page. Each hit has hitId, the message id for the other tools, a summary and the main fields in resource. moreResultsAvailable says whether to ask for the next page with from. Only work or school accounts can search; personal Outlook.com accounts get an error.
- Get messageGETReturns one message with its body as plain text, from, toRecipients, ccRecipients, receivedDateTime, conversationId, hasAttachments and webLink. Attachments are not included.
- Send messagePOSTSends a new email from the user's mailbox right away and saves a copy in Sent Items. The response is 202 with no body, so no message id comes back. To let someone review the email first, use Create draft.
- Reply to messagePOSTReplies right away to the sender of a message, or to its replyTo addresses when it has them, with the comment above the quoted original, and saves the reply in Sent Items. The response is 202 with no body. To answer everyone, use Reply all to message.
- Reply all to messagePOSTReplies right away to the sender and every recipient of a message, with the comment above the quoted original, and saves the reply in Sent Items. The response is 202 with no body.
- Forward messagePOSTForwards a message right away to new recipients, with the comment above the original, and saves it in Sent Items. The response is 202 with no body.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
