> For the complete documentation index, see [llms.txt](https://docs.fylr.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.fylr.io/for-developers/api/endpoints/api-message.md).

# /api/v1/message

Admin-managed **fylr** messages shown in the web front end, optionally requiring per-user confirmation (`confirm_every_version`, `show_always`) and optionally scoped to a `start_time`/`end_time` window. A message is addressed to user groups via `_groups`, not to individual users. All operations require the `system.message` system right (or `system.root`); a user who holds it sees and manages every message — there is no per-user sender/recipient scoping.

Differs from easydb 5: the message kind is the `webfrontend_type` field (free-form) and the body text is `message`; easydb 5 named these `type` (with values such as `eula`) and `message_html`.

### `GET /message` — List all messages.

{% openapi src="/files/kfiDjhyZfEICNBmt5f49" path="/message" method="get" %}
[fylr-openapi.yml](https://4100607288-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAdRFzQASDY2Elfdm3wXW%2Fuploads%2Fgit-blob-5375a8600236fc27b966430adf9d1363ba403643%2Ffylr-openapi.yml?alt=media)
{% endopenapi %}

### `POST /message` — Create or update one or more messages.

{% openapi src="/files/kfiDjhyZfEICNBmt5f49" path="/message" method="post" %}
[fylr-openapi.yml](https://4100607288-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAdRFzQASDY2Elfdm3wXW%2Fuploads%2Fgit-blob-5375a8600236fc27b966430adf9d1363ba403643%2Ffylr-openapi.yml?alt=media)
{% endopenapi %}

### `PUT /message` — Create or update one or more messages (alias for POST).

{% openapi src="/files/kfiDjhyZfEICNBmt5f49" path="/message" method="put" %}
[fylr-openapi.yml](https://4100607288-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAdRFzQASDY2Elfdm3wXW%2Fuploads%2Fgit-blob-5375a8600236fc27b966430adf9d1363ba403643%2Ffylr-openapi.yml?alt=media)
{% endopenapi %}

### `GET /message/{id}` — Retrieve a single message by id.

{% openapi src="/files/kfiDjhyZfEICNBmt5f49" path="/message/{id}" method="get" %}
[fylr-openapi.yml](https://4100607288-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAdRFzQASDY2Elfdm3wXW%2Fuploads%2Fgit-blob-5375a8600236fc27b966430adf9d1363ba403643%2Ffylr-openapi.yml?alt=media)
{% endopenapi %}

### `DELETE /message/{id}` — Delete a message by id.

{% openapi src="/files/kfiDjhyZfEICNBmt5f49" path="/message/{id}" method="delete" %}
[fylr-openapi.yml](https://4100607288-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAdRFzQASDY2Elfdm3wXW%2Fuploads%2Fgit-blob-5375a8600236fc27b966430adf9d1363ba403643%2Ffylr-openapi.yml?alt=media)
{% endopenapi %}