Create a new room
POST {{baseUrl}}/createRoom
Create a new room with various configuration options.
The server MUST apply the normal state resolution rules when creating the new room, including checking power levels for each event. It MUST apply the events implied by the request in the following order:
The
m.room.create
event itself. Must be the first event in the room.An
m.room.member
event for the creator to join the room. This is needed so the remaining events can be sent.A default
m.room.power_levels
event, giving the room creator (and not other members) permission to send state events. Overridden by thepower_level_content_override
parameter.An
m.room.canonical_alias
event ifroom_alias_name
is given.Events set by the
preset
. Currently these are them.room.join_rules
,m.room.history_visibility
, andm.room.guest_access
state events.Events listed in
initial_state
, in the order that they are listed.Events implied by
name
andtopic
(m.room.name
andm.room.topic
state events).Invite events implied by
invite
andinvite_3pid
(m.room.member
withmembership: invite
andm.room.third_party_invite
).
The available presets do the following with respect to room state:
Preset | join_rules | history_visibility | guest_access | Other |
---|---|---|---|---|
private_chat | invite | shared | can_join | |
trusted_private_chat | invite | shared | can_join | All invitees are given the same power level as the room creator. |
public_chat | public | shared | forbidden |
The server will create a m.room.create
event in the room with the
requesting user as the creator, alongside other keys provided in the
creation_content
.
Request Body
{"preset"=>"public_chat", "room_alias_name"=>"thepub", "name"=>"The Grand Duke Pub", "topic"=>"All about happy hour", "creation_content"=>{"m.federate"=>false}}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"room_id":"!sefiuhWgwghwWgh:example.com"}