summary refs log tree commit diff
path: root/docs/admin_api/server_notices.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/admin_api/server_notices.md')
-rw-r--r--docs/admin_api/server_notices.md48
1 files changed, 0 insertions, 48 deletions
diff --git a/docs/admin_api/server_notices.md b/docs/admin_api/server_notices.md
deleted file mode 100644

index ee306eab73..0000000000 --- a/docs/admin_api/server_notices.md +++ /dev/null
@@ -1,48 +0,0 @@ -# Server Notices - -The API to send notices is as follows: - -``` -POST /_synapse/admin/v1/send_server_notice -``` - -or: - -``` -PUT /_synapse/admin/v1/send_server_notice/{txnId} -``` - -You will need to authenticate with an access token for an admin user. - -When using the `PUT` form, retransmissions with the same transaction ID will be -ignored in the same way as with `PUT -/_matrix/client/r0/rooms/{roomId}/send/{eventType}/{txnId}`. - -The request body should look something like the following: - -```json -{ - "user_id": "@target_user:server_name", - "content": { - "msgtype": "m.text", - "body": "This is my message" - } -} -``` - -You can optionally include the following additional parameters: - -* `type`: the type of event. Defaults to `m.room.message`. -* `state_key`: Setting this will result in a state event being sent. - - -Once the notice has been sent, the API will return the following response: - -```json -{ - "event_id": "<event_id>" -} -``` - -Note that server notices must be enabled in `homeserver.yaml` before this API -can be used. See [the server notices documentation](../usage/configuration/server_notices.md) for more information.