Get notification email preferences
Returns the caller's notification email preferences as one entry per category.
Returns the caller's notification email preferences as one entry per category. The preferences array always contains all five categories — account, billing, usage, security, and product — each with a resolved emailEnabled boolean, so a client never has to know the category catalog in advance. A category with no stored preference resolves to emailEnabled: true, so a brand-new account is opted in to everything without any setup. Dairo checks these preferences before sending each notification email, so a category set to false here mutes that entire class of mail. Requires the account:read scope.
Scope: account:read. Send the API key as a bearer token; Scopes lists what each one reaches.
Request
Response
200 Success. Body: application/json, NotificationPreferencesResponse.
| Field | Type | Required | Description |
|---|---|---|---|
object | "notification_preferences" | yes | |
preferences | array of NotificationPreference | yes | One entry per notification category, with its resolved emailEnabled flag. |
Errors
Every error has the same body, {"error": {"type", "code", "message", "param"}}; branch on code. Errors lists every code.
| Status | Meaning |
|---|---|
400 | The request is malformed or a value is invalid (invalid_request, invalid_domain, idempotency_key_mismatch). |
401 | The API key is missing or invalid. |
403 | The key lacks the scope this endpoint needs (scope_missing) or may not do this (not_permitted). |
404 | No such resource in this account (resource_not_found). |
422 | The request is well-formed but a field failed validation (validation_failed). |
429 | Rate limit, plan limit, budget or spend cap reached (rate_limited, plan_limit_reached, budget_exceeded, spend_cap_reached). |
500 | An unexpected error; retry with backoff, then contact support (internal_error). |
Broadcast an email to an email list
Broadcasts one email to every active member of the list and returns 202 with a broadcast object: { "object": "broadcast", "id": "bcast_...", "audienceId", "status": "queued" }.
Update notification email preferences
Partially updates the caller's notification email preferences and returns the full resolved set for all five categories after the change.