Documentation · API reference
POST
/api/v1/sites/{site}/banner/publishPublish the draft
This page as Markdown, or in an AI chatMore ways to read this page
Publish the draft. A draft that fails a rule is refused.
# Publish the draft
> tidekeeper's API reference: https://tidekeeper.eu/docs/api/post-sites-site-banner-publish
`POST /api/v1/sites/{site}/banner/publish`
Publish the draft. A draft that fails a rule is refused.
## Parameters
- `site` (in path, needed): A site's id or name
## The answer
200, `BannerView`
- `asks_again` (boolean, needed): For a draft: publishing it asks everyone again. For a published version: it did.
- `config` (object, needed)
- `created_at` (integer, needed): Unix seconds.
- `publishable` (boolean, needed)
- `published_at` (integer or null)
- `rules` (list of object, needed): The rules, each with what was found (CB-02, CB-03, CB-13).
- `state` (string, needed): `draft`, `live` or `retired`.
- `version` (integer, needed)
## Asking
```sh
curl -X POST https://tidekeeper.eu/api/v1/sites/example.org/banner/publish \
-H "Authorization: Bearer $TIDEKEEPER_TOKEN"
```
Parameters
- sitein the address
- neededA site's id or name
The answer
Status 200
BannerView
- asks_again
- booleanneededFor a draft: publishing it asks everyone again. For a published version: it did.
- config
- objectneeded
- created_at
- integerneededUnix seconds.
- publishable
- booleanneeded
- published_at
- integer or null
- rules
- list of objectneededThe rules, each with what was found (CB-02, CB-03, CB-13).
- state
- stringneeded`draft`, `live` or `retired`.
- version
- integerneeded
Asking
curl -X POST https://tidekeeper.eu/api/v1/sites/example.org/banner/publish \ -H "Authorization: Bearer $TIDEKEEPER_TOKEN"
const answer = await fetch("https://tidekeeper.eu/api/v1/sites/example.org/banner/publish", { method: "POST", headers: { Authorization: `Bearer ${process.env.TIDEKEEPER_TOKEN}`, }, }).then((r) => r.json());