Documentation · API reference
POST
/api/v1/admin/tell-ownersOne mail to every owner of every account
This page as Markdown, or in an AI chatMore ways to read this page
One mail to every owner of every account. Operators only.
# One mail to every owner of every account
> tidekeeper's API reference: https://tidekeeper.eu/docs/api/post-admin-tell-owners
`POST /api/v1/admin/tell-owners`
One mail to every owner of every account. Operators only.
## What to send
`AdminTell`: One mail to every owner of every account (doc/audit-fixes.md 3.3): how the 30 days' notice of a change is given. Asked only to count, it sends none.
- `count_only` (boolean): Say how many it would go to, and send nothing.
- `subject` (string, needed)
- `text` (string, needed)
## The answer
200, `AdminTold`: How many it went to, and how many it would go to.
- `sent` (integer, needed)
- `would` (integer, needed)
## Asking
```sh
curl -X POST https://tidekeeper.eu/api/v1/admin/tell-owners \
-H "Authorization: Bearer $TIDEKEEPER_TOKEN" \
-H "Content-Type: application/json" \
-d '{"subject": "…", "text": "…"}'
```
What to send
AdminTell One mail to every owner of every account (doc/audit-fixes.md 3.3): how the 30 days' notice of a change is given. Asked only to count, it sends none.
- count_only
- booleanSay how many it would go to, and send nothing.
- subject
- stringneeded
- text
- stringneeded
The answer
Status 200
AdminTold How many it went to, and how many it would go to.
- sent
- integerneeded
- would
- integerneeded
Asking
curl -X POST https://tidekeeper.eu/api/v1/admin/tell-owners \ -H "Authorization: Bearer $TIDEKEEPER_TOKEN" \ -H "Content-Type: application/json" \ -d '{"subject": "…", "text": "…"}'
const answer = await fetch("https://tidekeeper.eu/api/v1/admin/tell-owners", { method: "POST", headers: { Authorization: `Bearer ${process.env.TIDEKEEPER_TOKEN}`, "Content-Type": "application/json", }, body: JSON.stringify({"subject": "…", "text": "…"}), }).then((r) => r.json());