Skip to content

AdminRoomLayoutService

Chatto exposes this service below /api/connect.

Shared message and enum definitions are documented in Shared Types And Enums.

Reads and mutates the server-admin room layout.

Lists the editable room group layout. Requires role.manage and returns visible room entries, including archived rooms for administrative actions such as unarchiving.

POST /api/connect/chatto.admin.v1.AdminRoomLayoutService/ListRoomGroups

Request for the server-admin room group layout.

Server-admin room group layout response.

FieldTypeDescription
groupsrepeated AdminRoomLayoutGroupOrdered room groups, including archived rooms the caller can manage.

Creates a room group. Requires role.manage.

POST /api/connect/chatto.admin.v1.AdminRoomLayoutService/CreateRoomGroup

Request to create a room group.

FieldTypeDescription
namestringRequired group display name.
descriptionstringOptional public group description.

Result of creating a room group.

FieldTypeDescription
groupAdminRoomLayoutGroupCreated room group.

Updates a room group’s metadata. Requires role.manage.

POST /api/connect/chatto.admin.v1.AdminRoomLayoutService/UpdateRoomGroup

Request to update a room group.

FieldTypeDescription
group_idstringRequired room group ID.
nameoptional stringNew group display name, when changing it.
descriptionoptional stringNew public group description, when changing it. Empty clears the description.

Result of updating a room group.

FieldTypeDescription
groupAdminRoomLayoutGroupUpdated room group.

Deletes an empty room group. Requires role.manage.

POST /api/connect/chatto.admin.v1.AdminRoomLayoutService/DeleteRoomGroup

Request to delete an empty room group.

FieldTypeDescription
group_idstringRequired room group ID.

Result of deleting a room group.

FieldTypeDescription
deletedboolTrue when the room group was deleted.

Replaces the global room group order. Requires role.manage.

POST /api/connect/chatto.admin.v1.AdminRoomLayoutService/ReorderRoomGroups

Request to replace the global room group order.

FieldTypeDescription
ordered_group_idsrepeated stringOrdered room group IDs. The list must include every existing group exactly once.

Result of replacing the global room group order.

FieldTypeDescription
groupsrepeated AdminRoomLayoutGroupRoom groups in their new order.

Moves a channel room to another room group. Requires room.manage in both source and destination groups.

POST /api/connect/chatto.admin.v1.AdminRoomLayoutService/MoveRoomToGroup

Request to move a channel room to another room group.

FieldTypeDescription
room_idstringRequired channel room ID.
group_idstringRequired destination room group ID.

Result of moving a channel room.

FieldTypeDescription
roomchatto.api.v1.RoomMoved room after the operation.

Replaces the mixed room/link sidebar order in one group. Requires room.manage in that group.

POST /api/connect/chatto.admin.v1.AdminRoomLayoutService/ReorderSidebarItemsInGroup

Request to replace the mixed sidebar item order in one group.

FieldTypeDescription
group_idstringRequired room group ID.
itemsrepeated AdminRoomLayoutItemInputOrdered room/sidebar-link item references.

Result: ReorderSidebarItemsInGroupResponse

Section titled “Result: ReorderSidebarItemsInGroupResponse”

Result of replacing the mixed sidebar item order.

FieldTypeDescription
groupAdminRoomLayoutGroupUpdated room group.

Creates a sidebar link. Requires room.manage in the destination group.

POST /api/connect/chatto.admin.v1.AdminRoomLayoutService/CreateSidebarLink

Request to create a sidebar link in one room group.

FieldTypeDescription
group_idstringRequired destination room group ID.
labelstringRequired display label.
urlstringRequired absolute http(s) URL or server-local path.

Result of creating a sidebar link.

FieldTypeDescription
sidebar_linkchatto.api.v1.SidebarLinkCreated sidebar link.

Updates a sidebar link. Requires room.manage in the link’s current group.

POST /api/connect/chatto.admin.v1.AdminRoomLayoutService/UpdateSidebarLink

Request to update a sidebar link.

FieldTypeDescription
link_idstringRequired sidebar link ID.
labeloptional stringNew display label, when changing it.
urloptional stringNew absolute http(s) URL or server-local path, when changing it.

Result of updating a sidebar link.

FieldTypeDescription
sidebar_linkchatto.api.v1.SidebarLinkUpdated sidebar link.

Deletes a sidebar link. Requires room.manage in the link’s current group.

POST /api/connect/chatto.admin.v1.AdminRoomLayoutService/DeleteSidebarLink

Request to delete a sidebar link.

FieldTypeDescription
link_idstringRequired sidebar link ID.

Result of deleting a sidebar link.

FieldTypeDescription
deletedboolTrue when the sidebar link was deleted.

Moves a sidebar link to another group. Requires room.manage in both source and destination groups.

POST /api/connect/chatto.admin.v1.AdminRoomLayoutService/MoveSidebarLinkToGroup

Request to move a sidebar link to another room group.

FieldTypeDescription
link_idstringRequired sidebar link ID.
group_idstringRequired destination room group ID.

Result of moving a sidebar link.

FieldTypeDescription
sidebar_linkchatto.api.v1.SidebarLinkMoved sidebar link.