SendCertificationNotificationRequest
A request or response body; the type column links to the schemas it refers to.
SendCertificationNotificationRequest
| Field | Type | Required | Description |
|---|---|---|---|
| user | string (uuid) | yes | `users.id` of the user the digest is about — and, unless `email` overrides it, the recipient (resolved from their account's profile). |
| audience | string | yes | Whose deadlines the digest covers: `trainee` — the user's own certification requirements; `manager` — the requirements of every trainee holding a role the user manages (scoped to those managed roles). one of "trainee" | "manager" |
| string (email) | no | Send to this address instead of the user's account email. | |
| dry_run | boolean | no | Build, render and validate the email without contacting the mail server. Defaults to false. |
| include_empty | boolean | no | Send an "all clear" email even when no requirement is overdue or due within 60 days and no training event is upcoming. Defaults to false (such digests are skipped). |
{
"user": "6f3b34d8-3c5e-4dd9-9f4e-2b52f0d9a1c7",
"audience": "trainee",
"email": "someone@example.com",
"dry_run": true,
"include_empty": true
}