Add a flag to initial sync to indicate we want rooms that the user has left

2026-02-05 05:43:43 +01:00 · 2015-10-08 17:25:38 +01:00 · 2015-10-08 17:25:38 +01:00 · 241096dc81
parent 2ab9372b16
commit 241096dc81
1 changed files with 10 additions and 0 deletions
--- a/api/client-server/v1/sync.yaml
+++ b/api/client-server/v1/sync.yaml
@ -39,6 +39,16 @@ paths:
          description: The maximum time in milliseconds to wait for an event.
          required: false
          x-example: "35000"
+        - in: query
+          type: string
+          name: archived
+          description: |-
+            Whether to include rooms that the user has left. If absent then
+            only rooms that the user has been invited to or has joined are
+            included. If set to "1" then rooms that the user has left are
+            included as well.
+          required: false
+          x-example: "1"
      responses:
        200:
          description: "The events received, which may be none."