/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.

List all messages.

get

Returns every stored message (no per-user filter), ordered by _id ascending. Requires the system.message system right.

Authorizations

BearerAuthAccessTokenQueryFylrAuthHeader

AuthorizationstringRequired

Access token in the Authorization header: Authorization: Bearer <token>.

Query parameters

limitinteger · int64Optional

Maximum number of messages to return. Results are ordered by _id ascending.

Default: 1000

offsetinteger · int64Optional

Number of leading messages to skip (for paging).

Default: 0

Responses

200

Array of messages.

application/json

An internal message addressed to one or more user groups. Used by fylr to display admin notifications, maintenance announcements and release notes inside the front end.

_basetypestring · enumRequired

Fixed marker identifying this object as a message.

Possible values:

_created_atstring · date-timeOptional

_updated_atstring · date-timeOptional

401

No authenticated user. The request must carry a valid access token.

application/json

403

The authenticated user lacks the system.message system right (and is not system.root). The response carries code: SystemRightRequired (package acl).

application/json

[
  {
    "_basetype": "message",
    "_groups": [
      {
        "_basetype": "group",
        "group": {
          "_id": 1,
          "_version": 1,
          "reference": "text",
          "name": "text",
          "comment": "text",
          "category_a": "text",
          "category_b": "text",
          "category_c": "text",
          "displayname": {
            "de-DE": "Deutscher text",
            "en-US": "English text"
          },
          "frontend_prefs": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "type": "easydb",
          "lookup:_id": {
            "reference": "text"
          }
        },
        "_generated_rights": {
          "ANY_ADDITIONAL_PROPERTY": {
            "_grantable": true,
            "allow_update_and_remove": true,
            "classes": [
              "text"
            ],
            "extensions": [
              "text"
            ],
            "versions": [
              "text"
            ],
            "limit": 1,
            "mask_ids": {
              "ANY_ADDITIONAL_PROPERTY": []
            },
            "column_ids": [
              1
            ],
            "objecttype_ids": [
              1
            ],
            "pool_ids": [
              1
            ]
          }
        },
        "_acl": [
          {
            "_id": 1,
            "who": {
              "_basetype": "user",
              "_owner": true,
              "_pool_contact": true,
              "user": {
                "_id": 1,
                "lookup:_id": {
                  "reference": "text"
                },
                "_generated_displayname": "text",
                "ANY_ADDITIONAL_PROPERTY": "anything"
              },
              "group": {
                "_id": 1,
                "lookup:_id": {
                  "reference": "text"
                },
                "_generated_displayname": "text"
              }
            },
            "sticky": true,
            "active": true,
            "_right_preset": 1,
            "when": {
              "from": "2026-08-11T21:03:11.646Z",
              "to": "2026-08-11T21:03:11.646Z"
            },
            "rights": {
              "ANY_ADDITIONAL_PROPERTY": {
                "_grantable": true,
                "allow_update_and_remove": true,
                "classes": [
                  "text"
                ],
                "extensions": [
                  "text"
                ],
                "versions": [
                  "text"
                ],
                "limit": 1,
                "mask_ids": {
                  "ANY_ADDITIONAL_PROPERTY": []
                },
                "column_ids": [
                  1
                ],
                "objecttype_ids": [
                  1
                ],
                "pool_ids": [
                  1
                ]
              }
            },
            "tagfilter": {
              "all": [
                1
              ],
              "any": [
                1
              ],
              "not": [
                1
              ],
              "changed": [
                1
              ]
            },
            "send_email_notification": {
              "text": "text"
            }
          }
        ],
        "_system_rights": {
          "system.user": {
            "read": true
          },
          "system.api.event": {
            "get": true
          },
          "system.api.publish": {
            "post": true,
            "get": true
          }
        },
        "_pseudonymization": {
          "user": {
            "login": "text",
            "first_name": "text",
            "last_name": "text",
            "displayname": "text",
            "additional_info": "text",
            "_emails": "text"
          }
        },
        "_auth_method_group_maps": {
          "sso": [
            {
              "method": "text",
              "value": "text"
            }
          ],
          "ldap": [
            {
              "method": "text",
              "value": "text"
            }
          ],
          "system": [
            {
              "method": "text",
              "value": "text"
            }
          ]
        },
        "_ip_subnet_filter": [
          "text"
        ],
        "_ip_subnet_filter_exclude": true,
        "_two_fa_required": true,
        "_owner": {
          "_basetype": "user",
          "_owner": true,
          "_pool_contact": true,
          "user": {
            "_id": 1,
            "lookup:_id": {
              "reference": "text"
            },
            "_generated_displayname": "text",
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "group": {
            "_id": 1,
            "lookup:_id": {
              "reference": "text"
            },
            "_generated_displayname": "text"
          }
        },
        "_created_at": "2026-08-11T21:03:11.646Z",
        "_updated_at": "2026-08-11T21:03:11.646Z",
        "_automatic_auth": {
          "type": "text",
          "timestamp": "2026-08-11T21:03:11.646Z"
        }
      }
    ],
    "message": {
      "_id": 1,
      "_version": 1,
      "webfrontend_props": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "webfrontend_type": "text",
      "confirm_every_version": true,
      "show_always": true,
      "reference": "text",
      "title": {
        "de-DE": "Deutscher text",
        "en-US": "English text"
      },
      "message": {
        "de-DE": "Deutscher text",
        "en-US": "English text"
      },
      "confirmation": {
        "de-DE": "Deutscher text",
        "en-US": "English text"
      },
      "client_ids": [
        "text"
      ],
      "start_time": {
        "value": "2026-08-11T21:03:11.646Z"
      },
      "end_time": {
        "value": "2026-08-11T21:03:11.646Z"
      }
    },
    "_created_at": "2026-08-11T21:03:11.646Z",
    "_updated_at": "2026-08-11T21:03:11.646Z"
  }
]

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

Create or update one or more messages.

post

Each array element is upserted by message._version: send _version: 1 to create a new message; send the stored version + 1 together with message._id to update an existing one (a mismatch returns VersionMismatch, 400). A save replaces the message's _groups set with the one supplied (an omitted/empty _groups clears it). Allowed in read-only mode.

Authorizations

BearerAuthAccessTokenQueryFylrAuthHeader

AuthorizationstringRequired

Access token in the Authorization header: Authorization: Bearer <token>.

Bodyobject · MessageApi[]

application/json

An internal message addressed to one or more user groups. Used by fylr to display admin notifications, maintenance announcements and release notes inside the front end.

_basetypestring · enumRequired

Fixed marker identifying this object as a message.

Possible values:

_created_atstring · date-timeOptional

_updated_atstring · date-timeOptional

Responses

200

The messages were created or updated.

application/json

An internal message addressed to one or more user groups. Used by fylr to display admin notifications, maintenance announcements and release notes inside the front end.

_basetypestring · enumRequired

Fixed marker identifying this object as a message.

Possible values:

_created_atstring · date-timeOptional

_updated_atstring · date-timeOptional

400

The request could not be processed. Possible causes: an unparseable body or other generic failure (code: ServerGeneric); an update whose _version is not the stored version + 1 (code: VersionMismatch); a start_time after the end_time (code: StartTimeAfterEndTime); or a _groups entry referencing a group (by reference) that does not exist (code: LookupNotFound).

application/json

401

No authenticated user. The request must carry a valid access token.

application/json

403

The authenticated user lacks the system.message system right (and is not system.root). The response carries code: SystemRightRequired (package acl).

application/json

[
  {
    "_basetype": "message",
    "_groups": [
      {
        "_basetype": "group",
        "group": {
          "_id": 1,
          "_version": 1,
          "reference": "text",
          "name": "text",
          "comment": "text",
          "category_a": "text",
          "category_b": "text",
          "category_c": "text",
          "displayname": {
            "de-DE": "Deutscher text",
            "en-US": "English text"
          },
          "frontend_prefs": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "type": "easydb",
          "lookup:_id": {
            "reference": "text"
          }
        },
        "_generated_rights": {
          "ANY_ADDITIONAL_PROPERTY": {
            "_grantable": true,
            "allow_update_and_remove": true,
            "classes": [
              "text"
            ],
            "extensions": [
              "text"
            ],
            "versions": [
              "text"
            ],
            "limit": 1,
            "mask_ids": {
              "ANY_ADDITIONAL_PROPERTY": []
            },
            "column_ids": [
              1
            ],
            "objecttype_ids": [
              1
            ],
            "pool_ids": [
              1
            ]
          }
        },
        "_acl": [
          {
            "_id": 1,
            "who": {
              "_basetype": "user",
              "_owner": true,
              "_pool_contact": true,
              "user": {
                "_id": 1,
                "lookup:_id": {
                  "reference": "text"
                },
                "_generated_displayname": "text",
                "ANY_ADDITIONAL_PROPERTY": "anything"
              },
              "group": {
                "_id": 1,
                "lookup:_id": {
                  "reference": "text"
                },
                "_generated_displayname": "text"
              }
            },
            "sticky": true,
            "active": true,
            "_right_preset": 1,
            "when": {
              "from": "2026-08-11T21:03:11.646Z",
              "to": "2026-08-11T21:03:11.646Z"
            },
            "rights": {
              "ANY_ADDITIONAL_PROPERTY": {
                "_grantable": true,
                "allow_update_and_remove": true,
                "classes": [
                  "text"
                ],
                "extensions": [
                  "text"
                ],
                "versions": [
                  "text"
                ],
                "limit": 1,
                "mask_ids": {
                  "ANY_ADDITIONAL_PROPERTY": []
                },
                "column_ids": [
                  1
                ],
                "objecttype_ids": [
                  1
                ],
                "pool_ids": [
                  1
                ]
              }
            },
            "tagfilter": {
              "all": [
                1
              ],
              "any": [
                1
              ],
              "not": [
                1
              ],
              "changed": [
                1
              ]
            },
            "send_email_notification": {
              "text": "text"
            }
          }
        ],
        "_system_rights": {
          "system.user": {
            "read": true
          },
          "system.api.event": {
            "get": true
          },
          "system.api.publish": {
            "post": true,
            "get": true
          }
        },
        "_pseudonymization": {
          "user": {
            "login": "text",
            "first_name": "text",
            "last_name": "text",
            "displayname": "text",
            "additional_info": "text",
            "_emails": "text"
          }
        },
        "_auth_method_group_maps": {
          "sso": [
            {
              "method": "text",
              "value": "text"
            }
          ],
          "ldap": [
            {
              "method": "text",
              "value": "text"
            }
          ],
          "system": [
            {
              "method": "text",
              "value": "text"
            }
          ]
        },
        "_ip_subnet_filter": [
          "text"
        ],
        "_ip_subnet_filter_exclude": true,
        "_two_fa_required": true,
        "_owner": {
          "_basetype": "user",
          "_owner": true,
          "_pool_contact": true,
          "user": {
            "_id": 1,
            "lookup:_id": {
              "reference": "text"
            },
            "_generated_displayname": "text",
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "group": {
            "_id": 1,
            "lookup:_id": {
              "reference": "text"
            },
            "_generated_displayname": "text"
          }
        },
        "_created_at": "2026-08-11T21:03:11.646Z",
        "_updated_at": "2026-08-11T21:03:11.646Z",
        "_automatic_auth": {
          "type": "text",
          "timestamp": "2026-08-11T21:03:11.646Z"
        }
      }
    ],
    "message": {
      "_id": 1,
      "_version": 1,
      "webfrontend_props": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "webfrontend_type": "text",
      "confirm_every_version": true,
      "show_always": true,
      "reference": "text",
      "title": {
        "de-DE": "Deutscher text",
        "en-US": "English text"
      },
      "message": {
        "de-DE": "Deutscher text",
        "en-US": "English text"
      },
      "confirmation": {
        "de-DE": "Deutscher text",
        "en-US": "English text"
      },
      "client_ids": [
        "text"
      ],
      "start_time": {
        "value": "2026-08-11T21:03:11.646Z"
      },
      "end_time": {
        "value": "2026-08-11T21:03:11.646Z"
      }
    },
    "_created_at": "2026-08-11T21:03:11.646Z",
    "_updated_at": "2026-08-11T21:03:11.646Z"
  }
]

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

Create or update one or more messages (alias for POST).

put

Identical to POST /message: the same handler decodes the body and upserts each element by message._version.

Authorizations

BearerAuthAccessTokenQueryFylrAuthHeader

AuthorizationstringRequired

Access token in the Authorization header: Authorization: Bearer <token>.

Bodyobject · MessageApi[]

application/json

An internal message addressed to one or more user groups. Used by fylr to display admin notifications, maintenance announcements and release notes inside the front end.

_basetypestring · enumRequired

Fixed marker identifying this object as a message.

Possible values:

_created_atstring · date-timeOptional

_updated_atstring · date-timeOptional

Responses

200

The messages were created or updated.

application/json

An internal message addressed to one or more user groups. Used by fylr to display admin notifications, maintenance announcements and release notes inside the front end.

_basetypestring · enumRequired

Fixed marker identifying this object as a message.

Possible values:

_created_atstring · date-timeOptional

_updated_atstring · date-timeOptional

400

The request could not be processed. Possible causes: an unparseable body or other generic failure (code: ServerGeneric); an update whose _version is not the stored version + 1 (code: VersionMismatch); a start_time after the end_time (code: StartTimeAfterEndTime); or a _groups entry referencing a group (by reference) that does not exist (code: LookupNotFound).

application/json

401

No authenticated user. The request must carry a valid access token.

application/json

403

The authenticated user lacks the system.message system right (and is not system.root). The response carries code: SystemRightRequired (package acl).

application/json

[
  {
    "_basetype": "message",
    "_groups": [
      {
        "_basetype": "group",
        "group": {
          "_id": 1,
          "_version": 1,
          "reference": "text",
          "name": "text",
          "comment": "text",
          "category_a": "text",
          "category_b": "text",
          "category_c": "text",
          "displayname": {
            "de-DE": "Deutscher text",
            "en-US": "English text"
          },
          "frontend_prefs": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "type": "easydb",
          "lookup:_id": {
            "reference": "text"
          }
        },
        "_generated_rights": {
          "ANY_ADDITIONAL_PROPERTY": {
            "_grantable": true,
            "allow_update_and_remove": true,
            "classes": [
              "text"
            ],
            "extensions": [
              "text"
            ],
            "versions": [
              "text"
            ],
            "limit": 1,
            "mask_ids": {
              "ANY_ADDITIONAL_PROPERTY": []
            },
            "column_ids": [
              1
            ],
            "objecttype_ids": [
              1
            ],
            "pool_ids": [
              1
            ]
          }
        },
        "_acl": [
          {
            "_id": 1,
            "who": {
              "_basetype": "user",
              "_owner": true,
              "_pool_contact": true,
              "user": {
                "_id": 1,
                "lookup:_id": {
                  "reference": "text"
                },
                "_generated_displayname": "text",
                "ANY_ADDITIONAL_PROPERTY": "anything"
              },
              "group": {
                "_id": 1,
                "lookup:_id": {
                  "reference": "text"
                },
                "_generated_displayname": "text"
              }
            },
            "sticky": true,
            "active": true,
            "_right_preset": 1,
            "when": {
              "from": "2026-08-11T21:03:11.646Z",
              "to": "2026-08-11T21:03:11.646Z"
            },
            "rights": {
              "ANY_ADDITIONAL_PROPERTY": {
                "_grantable": true,
                "allow_update_and_remove": true,
                "classes": [
                  "text"
                ],
                "extensions": [
                  "text"
                ],
                "versions": [
                  "text"
                ],
                "limit": 1,
                "mask_ids": {
                  "ANY_ADDITIONAL_PROPERTY": []
                },
                "column_ids": [
                  1
                ],
                "objecttype_ids": [
                  1
                ],
                "pool_ids": [
                  1
                ]
              }
            },
            "tagfilter": {
              "all": [
                1
              ],
              "any": [
                1
              ],
              "not": [
                1
              ],
              "changed": [
                1
              ]
            },
            "send_email_notification": {
              "text": "text"
            }
          }
        ],
        "_system_rights": {
          "system.user": {
            "read": true
          },
          "system.api.event": {
            "get": true
          },
          "system.api.publish": {
            "post": true,
            "get": true
          }
        },
        "_pseudonymization": {
          "user": {
            "login": "text",
            "first_name": "text",
            "last_name": "text",
            "displayname": "text",
            "additional_info": "text",
            "_emails": "text"
          }
        },
        "_auth_method_group_maps": {
          "sso": [
            {
              "method": "text",
              "value": "text"
            }
          ],
          "ldap": [
            {
              "method": "text",
              "value": "text"
            }
          ],
          "system": [
            {
              "method": "text",
              "value": "text"
            }
          ]
        },
        "_ip_subnet_filter": [
          "text"
        ],
        "_ip_subnet_filter_exclude": true,
        "_two_fa_required": true,
        "_owner": {
          "_basetype": "user",
          "_owner": true,
          "_pool_contact": true,
          "user": {
            "_id": 1,
            "lookup:_id": {
              "reference": "text"
            },
            "_generated_displayname": "text",
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "group": {
            "_id": 1,
            "lookup:_id": {
              "reference": "text"
            },
            "_generated_displayname": "text"
          }
        },
        "_created_at": "2026-08-11T21:03:11.646Z",
        "_updated_at": "2026-08-11T21:03:11.646Z",
        "_automatic_auth": {
          "type": "text",
          "timestamp": "2026-08-11T21:03:11.646Z"
        }
      }
    ],
    "message": {
      "_id": 1,
      "_version": 1,
      "webfrontend_props": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "webfrontend_type": "text",
      "confirm_every_version": true,
      "show_always": true,
      "reference": "text",
      "title": {
        "de-DE": "Deutscher text",
        "en-US": "English text"
      },
      "message": {
        "de-DE": "Deutscher text",
        "en-US": "English text"
      },
      "confirmation": {
        "de-DE": "Deutscher text",
        "en-US": "English text"
      },
      "client_ids": [
        "text"
      ],
      "start_time": {
        "value": "2026-08-11T21:03:11.646Z"
      },
      "end_time": {
        "value": "2026-08-11T21:03:11.646Z"
      }
    },
    "_created_at": "2026-08-11T21:03:11.646Z",
    "_updated_at": "2026-08-11T21:03:11.646Z"
  }
]

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

Retrieve a single message by id.

get

Returns the matching message wrapped in a one-element array (the same handler shape as the list endpoint), not a bare object.

Authorizations

BearerAuthAccessTokenQueryFylrAuthHeader

AuthorizationstringRequired

Access token in the Authorization header: Authorization: Bearer <token>.

Path parameters

idinteger · int64 · min: 1Required

The message's _id.

Responses

200

A one-element array containing the message.

application/json

An internal message addressed to one or more user groups. Used by fylr to display admin notifications, maintenance announcements and release notes inside the front end.

_basetypestring · enumRequired

Fixed marker identifying this object as a message.

Possible values:

_created_atstring · date-timeOptional

_updated_atstring · date-timeOptional

401

No authenticated user. The request must carry a valid access token.

application/json

403

The authenticated user lacks the system.message system right (and is not system.root). The response carries code: SystemRightRequired (package acl).

application/json

404

The message id in the URL does not match any stored message. The response carries code: MessageNotFound (package message).

application/json

[
  {
    "_basetype": "message",
    "_groups": [
      {
        "_basetype": "group",
        "group": {
          "_id": 1,
          "_version": 1,
          "reference": "text",
          "name": "text",
          "comment": "text",
          "category_a": "text",
          "category_b": "text",
          "category_c": "text",
          "displayname": {
            "de-DE": "Deutscher text",
            "en-US": "English text"
          },
          "frontend_prefs": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "type": "easydb",
          "lookup:_id": {
            "reference": "text"
          }
        },
        "_generated_rights": {
          "ANY_ADDITIONAL_PROPERTY": {
            "_grantable": true,
            "allow_update_and_remove": true,
            "classes": [
              "text"
            ],
            "extensions": [
              "text"
            ],
            "versions": [
              "text"
            ],
            "limit": 1,
            "mask_ids": {
              "ANY_ADDITIONAL_PROPERTY": []
            },
            "column_ids": [
              1
            ],
            "objecttype_ids": [
              1
            ],
            "pool_ids": [
              1
            ]
          }
        },
        "_acl": [
          {
            "_id": 1,
            "who": {
              "_basetype": "user",
              "_owner": true,
              "_pool_contact": true,
              "user": {
                "_id": 1,
                "lookup:_id": {
                  "reference": "text"
                },
                "_generated_displayname": "text",
                "ANY_ADDITIONAL_PROPERTY": "anything"
              },
              "group": {
                "_id": 1,
                "lookup:_id": {
                  "reference": "text"
                },
                "_generated_displayname": "text"
              }
            },
            "sticky": true,
            "active": true,
            "_right_preset": 1,
            "when": {
              "from": "2026-08-11T21:03:11.646Z",
              "to": "2026-08-11T21:03:11.646Z"
            },
            "rights": {
              "ANY_ADDITIONAL_PROPERTY": {
                "_grantable": true,
                "allow_update_and_remove": true,
                "classes": [
                  "text"
                ],
                "extensions": [
                  "text"
                ],
                "versions": [
                  "text"
                ],
                "limit": 1,
                "mask_ids": {
                  "ANY_ADDITIONAL_PROPERTY": []
                },
                "column_ids": [
                  1
                ],
                "objecttype_ids": [
                  1
                ],
                "pool_ids": [
                  1
                ]
              }
            },
            "tagfilter": {
              "all": [
                1
              ],
              "any": [
                1
              ],
              "not": [
                1
              ],
              "changed": [
                1
              ]
            },
            "send_email_notification": {
              "text": "text"
            }
          }
        ],
        "_system_rights": {
          "system.user": {
            "read": true
          },
          "system.api.event": {
            "get": true
          },
          "system.api.publish": {
            "post": true,
            "get": true
          }
        },
        "_pseudonymization": {
          "user": {
            "login": "text",
            "first_name": "text",
            "last_name": "text",
            "displayname": "text",
            "additional_info": "text",
            "_emails": "text"
          }
        },
        "_auth_method_group_maps": {
          "sso": [
            {
              "method": "text",
              "value": "text"
            }
          ],
          "ldap": [
            {
              "method": "text",
              "value": "text"
            }
          ],
          "system": [
            {
              "method": "text",
              "value": "text"
            }
          ]
        },
        "_ip_subnet_filter": [
          "text"
        ],
        "_ip_subnet_filter_exclude": true,
        "_two_fa_required": true,
        "_owner": {
          "_basetype": "user",
          "_owner": true,
          "_pool_contact": true,
          "user": {
            "_id": 1,
            "lookup:_id": {
              "reference": "text"
            },
            "_generated_displayname": "text",
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "group": {
            "_id": 1,
            "lookup:_id": {
              "reference": "text"
            },
            "_generated_displayname": "text"
          }
        },
        "_created_at": "2026-08-11T21:03:11.646Z",
        "_updated_at": "2026-08-11T21:03:11.646Z",
        "_automatic_auth": {
          "type": "text",
          "timestamp": "2026-08-11T21:03:11.646Z"
        }
      }
    ],
    "message": {
      "_id": 1,
      "_version": 1,
      "webfrontend_props": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "webfrontend_type": "text",
      "confirm_every_version": true,
      "show_always": true,
      "reference": "text",
      "title": {
        "de-DE": "Deutscher text",
        "en-US": "English text"
      },
      "message": {
        "de-DE": "Deutscher text",
        "en-US": "English text"
      },
      "confirmation": {
        "de-DE": "Deutscher text",
        "en-US": "English text"
      },
      "client_ids": [
        "text"
      ],
      "start_time": {
        "value": "2026-08-11T21:03:11.646Z"
      },
      "end_time": {
        "value": "2026-08-11T21:03:11.646Z"
      }
    },
    "_created_at": "2026-08-11T21:03:11.646Z",
    "_updated_at": "2026-08-11T21:03:11.646Z"
  }
]

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

Delete a message by id.

delete

Authorizations

BearerAuthAccessTokenQueryFylrAuthHeader

AuthorizationstringRequired

Access token in the Authorization header: Authorization: Bearer <token>.

Path parameters

idinteger · int64 · min: 1Required

Responses

200

The message was deleted.

application/json

401

No authenticated user. The request must carry a valid access token.

application/json

403

The authenticated user lacks the system.message system right (and is not system.root). The response carries code: SystemRightRequired (package acl).

application/json

404

The message id in the URL does not match any stored message. The response carries code: MessageNotFound (package message).

application/json

{
  "status": {
    "acknowledged": "ok"
  }
}