summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorErik Johnston <erik@matrix.org>2014-09-06 01:12:12 +0100
committerErik Johnston <erik@matrix.org>2014-09-06 01:12:12 +0100
commit684001ac62aabb7697d815b2e49d8a76c9e35d49 (patch)
tree07b78bf4ed903f5765d4321e92606d547373ecdc /docs
parentAdd support for inviting people when you create a room (diff)
downloadsynapse-684001ac62aabb7697d815b2e49d8a76c9e35d49.tar.xz
Document new invite key added to createRoom api
Diffstat (limited to '')
-rw-r--r--docs/specification.rst10
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/specification.rst b/docs/specification.rst
index 6776579d33..5b044459e2 100644
--- a/docs/specification.rst
+++ b/docs/specification.rst
@@ -418,6 +418,16 @@ which can be set when creating a room:
     If this is included, an ``m.room.topic`` event will be sent into the room to indicate the
     topic for the room. See `Room Events`_ for more information on ``m.room.topic``.
 
+``invite``
+  Type:
+    List
+  Optional:
+    Yes
+  Value:
+    A list of user ids to invite.
+  Description:
+    This will tell the server to invite everyone in the list to the newly created room.
+
 Example::
 
   {