Role Menus

GET /api/guilds/{guild_id}/role-menus

ListRoleMenus

Parameters

Name	In	Type	Required	Description
guild_id	path	integer	yes

Response 200 — Request fulfilled, document follows

Model: array of RoleMenuSchema

Type: array of RoleMenuSchema

POST /api/guilds/{guild_id}/role-menus

CreateRoleMenu

Parameters

Name	In	Type	Required	Description
guild_id	path	integer	yes

Request body

Model: RoleMenuCreate

Field	Type	Required	Description
channel_id	integer	yes
title	string	yes
description	string | null	no
max_roles	integer	no

Response 201 — Document created, URL follows

Model: RoleMenuSchema

Field	Type	Required	Description
id	string (uuid)	yes
guild_id	integer	yes
channel_id	integer	yes
message_id	integer | null	yes
title	string	yes
description	string | null	yes
max_roles	integer	yes
options	array of RoleMenuOptionSchema	yes

DELETE /api/guilds/{guild_id}/role-menus/{menu_id}

DeleteRoleMenu

Parameters

Name	In	Type	Required	Description
guild_id	path	integer	yes
menu_id	path	string (uuid)	yes

Response 204 — Request fulfilled, nothing follows

GET /api/guilds/{guild_id}/role-menus/{menu_id}

GetRoleMenu

Parameters

Name	In	Type	Required	Description
guild_id	path	integer	yes
menu_id	path	string (uuid)	yes

Response 200 — Request fulfilled, document follows

Model: RoleMenuSchema

Field	Type	Required	Description
id	string (uuid)	yes
guild_id	integer	yes
channel_id	integer	yes
message_id	integer | null	yes
title	string	yes
description	string | null	yes
max_roles	integer	yes
options	array of RoleMenuOptionSchema	yes

PATCH /api/guilds/{guild_id}/role-menus/{menu_id}

UpdateRoleMenu

Parameters

Name	In	Type	Required	Description
guild_id	path	integer	yes
menu_id	path	string (uuid)	yes

Request body

Model: RoleMenuUpdate

Field	Type	Required	Description
channel_id	integer | null	no
message_id	integer | null	no
title	string | null	no
description	string | null	no
max_roles	integer | null	no

Response 200 — Request fulfilled, document follows

Model: RoleMenuSchema

Field	Type	Required	Description
id	string (uuid)	yes
guild_id	integer	yes
channel_id	integer	yes
message_id	integer | null	yes
title	string	yes
description	string | null	yes
max_roles	integer	yes
options	array of RoleMenuOptionSchema	yes

DELETE /api/guilds/{guild_id}/role-menus/{menu_id}/options/{role_id}

DeleteRoleMenuOption

Parameters

Name	In	Type	Required	Description
guild_id	path	integer	yes
menu_id	path	string (uuid)	yes
role_id	path	integer	yes

Response 200 — Request fulfilled, document follows

Model: RoleMenuSchema

Field	Type	Required	Description
id	string (uuid)	yes
guild_id	integer	yes
channel_id	integer	yes
message_id	integer | null	yes
title	string	yes
description	string | null	yes
max_roles	integer	yes
options	array of RoleMenuOptionSchema	yes

PUT /api/guilds/{guild_id}/role-menus/{menu_id}/options/{role_id}

UpsertRoleMenuOption

Parameters

Name	In	Type	Required	Description
guild_id	path	integer	yes
menu_id	path	string (uuid)	yes
role_id	path	integer	yes

Request body

Model: RoleMenuOptionUpsert

Field	Type	Required	Description
label	string	yes
emoji	string | null	no
description	string | null	no
position	integer | null	no

Response 200 — Request fulfilled, document follows

Model: RoleMenuSchema

Field	Type	Required	Description
id	string (uuid)	yes
guild_id	integer	yes
channel_id	integer	yes
message_id	integer | null	yes
title	string	yes
description	string | null	yes
max_roles	integer	yes
options	array of RoleMenuOptionSchema	yes