Skip to content

AdminAnnouncementInput

The title, the text, and the window of an announcement.

object
title
required

The heading, in plain text: 1 to 100 grapheme clusters on one line, without control characters. White space around it is trimmed.

string
>= 1 characters
text
required

The text, in Markdown.

string
>= 1 characters <= 5000 characters
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, after starts_at; omitted to show it until it is withdrawn.

string format: date-time

Example generated

{
"title": "example",
"text": "example",
"starts_at": "2026-04-15T12:00:00Z",
"ends_at": "2026-04-15T12:00:00Z"
}

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

Analytics on this site