Returning.AI
Light Mode
create new role
DevelopingPOST
/rolesRequest
Body Params application/json
class
string
required
serverId
string
required
title
string
required
description
string
required
order
integer
required
billable
boolean
required
serverPermissions
object
required
allow_dm
boolean
required
create_invite
boolean
required
kick_members
boolean
required
ban_members
boolean
required
warn_members
boolean
required
suspend_members
boolean
required
broadcast_messages
boolean
required
overwrite_language_settings
boolean
required
manage_roles
boolean
required
manage_channels
boolean
required
server_administrator
boolean
required
channelPermissions
object
required
view_message_history
boolean
required
manage_messages
boolean
required
delete_messages
boolean
required
allow_mentions
boolean
required
post_messages
boolean
required
post_analysis
boolean
required
attach_files
boolean
required
Example
{
"class": "red",
"serverId": "{{serverId}}",
"title": "Manager 2",
"description": "Role with permissions to moderate the server",
"order": 1,
"billable": true,
"serverPermissions": {
"allow_dm": true,
"create_invite": true,
"kick_members": true,
"ban_members": true,
"warn_members": true,
"suspend_members": true,
"broadcast_messages": true,
"overwrite_language_settings": true,
"manage_roles": true,
"manage_channels": true,
"server_administrator": true
},
"channelPermissions": {
"view_message_history": true,
"manage_messages": true,
"delete_messages": true,
"allow_mentions": true,
"post_messages": true,
"post_analysis": true,
"attach_files": true
}
}
Request samples
Responses
Success(200)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
meta
object
required
success
boolean
required
message
string
required
devMessage
string
required
body
object
required
order
integer
required
billable
boolean
required
title
string
required
description
string
required
serverPermissions
object
required
channelPermissions
object
required
class
string
required
serverId
string
required
_id
string
required
createdAt
string
required
updatedAt
string
required
__v
integer
required
Example
{
"meta": {
"success": true,
"message": "Role has been created successfully",
"devMessage": "Role has been created successfully"
},
"body": {
"order": 1,
"billable": true,
"title": "Moderator",
"description": "Role with permissions to moderate the server",
"serverPermissions": {
"allow_dm": true,
"create_invite": true,
"kick_members": true,
"ban_members": true,
"manage_roles": true,
"manage_channels": true,
"server_administrator": true,
"_id": "66b19ef7f094135bf7a40698"
},
"channelPermissions": {
"view_message_history": true,
"manage_messages": true,
"allow_mentions": true,
"post_messages": true,
"post_analysis": true,
"attach_files": true,
"_id": "66b19ef7f094135bf7a40699"
},
"class": "red",
"serverId": "66aa457640dc82b222987747",
"_id": "66b19ef7f094135bf7a40697",
"createdAt": "2024-08-06T03:56:39.162Z",
"updatedAt": "2024-08-06T03:56:39.162Z",
"__v": 0
}
}
Modified at a month ago