---
title: "notifications.email-report"
method: POST
path: "/capabilities/notifications.email-report"
tags: ["Capabilities"]
---

# notifications.email-report

`POST /capabilities/notifications.email-report`

## Request

- Base URL: `https://developer.api.receiptor.ai/v1`
- URL: `https://developer.api.receiptor.ai/v1/capabilities/notifications.email-report`
- Auth: one of:
  - API key in header `x-receiptor-api-key`
  - HTTP bearer
- TypeScript: <https://skmtc.dev/receiptor/apis/receiptor-ai-api/docs/capabilities/notifications.email-report/post.ts> (a function with typed inputs; its response is checked against the schema)

Email a report (a title and plain text, with an optional link) to members of this workspace. Addresses that are not members of the workspace are refused, and the result says which. Check `sent`: zero means nobody received it.

## Request body

- object
  - `title` string, required: The email subject, for example a one-line headline.
  - `body` string, required: The report as plain text. Line breaks are kept; HTML and Markdown are shown as typed.
  - `recipients` string[], required: Email addresses of members of this workspace. Anyone who is not a member is refused.
  - `sourceName` string: Where the report comes from, for example an agent's name.
  - `link` string, uri: An https link to open the full report.

## Response `200`

Successful response

- object
  - `success` boolean
  - `code` integer
  - `data` object
    - `result` object: Capability-specific result

## Other responses

- `400`: Invalid input
- `401`: Authentication required
- `404`: Resource not found

## Changes

- **2026-10-26** `42d06d1590f4`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/receiptor/apis/receiptor-ai-api/changes/capabilities/notifications.email-report/post.md)

---

[API](https://skmtc.dev/receiptor/apis/receiptor-ai-api.md) - [All operations](https://skmtc.dev/receiptor/apis/receiptor-ai-api/llms.txt) - [OpenAPI document](https://skmtc.dev/receiptor/apis/receiptor-ai-api/revisions/6eb4ebb559f2?raw)
