POST /reports/{id}:email

Email report

F2: HTML summary to an explicit address ({to} only).

Bearer API key or staff session application/json operation emailReport

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	—

Request

Content type: application/json

The contract does not publish field-level properties for this request; the example below sends an empty object. Replace it with the payload described by the endpoint.

curl -X POST "$MONICHEK_API/reports/{id}:email" \
  -H "Authorization: Bearer $MONICHEK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

const res = await fetch(`${MONICHEK_API}/reports/{id}:email`, {
  method: "POST",
  headers: {
    Authorization: `Bearer ${MONICHEK_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});

const data = await res.json();

import os
import requests

res = requests.post(
    f"{os.environ['MONICHEK_API']}/reports/{id}:email",
    headers={"Authorization": f"Bearer {os.environ['MONICHEK_API_KEY']}"},
    json={},
)
print(res.json())

$ch = curl_init(getenv('MONICHEK_API') . '/reports/{id}:email');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('MONICHEK_API_KEY'),
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode([]),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Replace {id} with the resource id.

Responses

200 OK emailed application/json

{
  "object": "emailed",
  "id": "rpt_01M3R...",
  "to": "[email protected]"
}

Error responses

Status	Meaning	Body
401	Unauthorized	RFC 9457 problem
404	Not Found	RFC 9457 problem
422	Unprocessable Entity	RFC 9457 problem

Errors use the RFC 9457 problem format with a stable code.