REreceiptor
Capabilities

notifications.email-report

Changed on

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.

post/capabilities/notifications.email-report

Request

Request body

titlestring required

The email subject, for example a one-line headline.

bodystring required

The report as plain text. Line breaks are kept; HTML and Markdown are shown as typed.

recipientsstring[] required

Email addresses of members of this workspace. Anyone who is not a member is refused.

sourceNamestring

Where the report comes from, for example an agent's name.

linkstring uri

An https link to open the full report.

Response

Successful response

successboolean
codeinteger

Example response

{
  "success": true,
  "code": 200
}

Changes