Put digest

This page as Markdown, or in an AI chatMore ways to read this page

# Put digest

> tidekeeper's API reference: https://tidekeeper.eu/docs/api/put-reports-digest

`PUT /api/v1/reports/digest`

## What to send

`ReportSetting`: Who is sent a site's report, or the digest of every site, and how often.

- `every` (string, needed): `off`, `weekly` or `monthly`.
- `sends` (string): When it goes out, in words. Set by the server.
- `to` (list of string)

## The answer

200, `ReportSetting`: Who is sent a site's report, or the digest of every site, and how often.

- `every` (string, needed): `off`, `weekly` or `monthly`.
- `sends` (string): When it goes out, in words. Set by the server.
- `to` (list of string)

## Asking

```sh
curl -X PUT https://tidekeeper.eu/api/v1/reports/digest \
    -H "Authorization: Bearer $TIDEKEEPER_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{"every": "…"}'
```

What to send

ReportSetting Who is sent a site's report, or the digest of every site, and how often.

every: stringneeded`off`, `weekly` or `monthly`.
sends: stringWhen it goes out, in words. Set by the server.
to: list of string

The answer

Status 200

ReportSetting Who is sent a site's report, or the digest of every site, and how often.

every: stringneeded`off`, `weekly` or `monthly`.
sends: stringWhen it goes out, in words. Set by the server.
to: list of string

Asking

curlJavaScript

With your token from Settings

curl -X PUT https://tidekeeper.eu/api/v1/reports/digest \
    -H "Authorization: Bearer $TIDEKEEPER_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{"every": "…"}'

With your token from Settings

const answer = await fetch("https://tidekeeper.eu/api/v1/reports/digest", {
  method: "PUT",
  headers: {
    Authorization: `Bearer ${process.env.TIDEKEEPER_TOKEN}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"every": "…"}),
}).then((r) => r.json());