Skip to content

AdminAnnouncement

An announcement with its Markdown text and its state.

object
id
required

The ID of a resource, a UUIDv7 in its canonical string form.

string format: uuid
title
required

The heading, in plain text.

string
text
required

The text, in Markdown.

string
content
required

The text as the users get it, an HTML fragment (Announcement.content).

string
state
required

draft: no user sees it. published: every local user sees it within its window. withdrawn: taken down for good.

string
Allowed values: draft published withdrawn
starts_at

When it starts to show once published; omitted to show it from its publication.

string format: date-time
ends_at

When it stops showing; omitted to show it until it is withdrawn.

string format: date-time
published_at

When it was last published; omitted for a draft.

string format: date-time
created_at
required
string format: date-time
revised_at
required

When its text or window last changed.

string format: date-time

Example generated

{
"id": "01890a5d-ac96-774b-bcce-b302099a8057",
"title": "example",
"text": "example",
"content": "example",
"state": "draft",
"starts_at": "2026-04-15T12:00:00Z",
"ends_at": "2026-04-15T12:00:00Z",
"published_at": "2026-04-15T12:00:00Z",
"created_at": "2026-04-15T12:00:00Z",
"revised_at": "2026-04-15T12:00:00Z"
}

For LLMs and coding agents:llms.txt,llms-full.txt, llms-small.txt

Analytics on this site