- Returning.AI
- Auth
- Server
- Role
- Channel
- Badge
- Integration
- Application
create new role
Developing
POST
/roles
Request
Header Params
x-api-key
string
required
Example:
{{x-api-key}}
Body Params application/json
class
string
required
title
string
required
order
integer
required
billable
boolean
required
server_permissions
object
required
server_administrator
boolean
required
allow_dm
boolean
required
create_invite
boolean
required
warn_members
boolean
required
suspend_members
boolean
required
ban_members
boolean
required
broadcast_messages
boolean
required
overwrite_language
boolean
required
channel_permissions
object
required
post_messages
boolean
required
attach_files
boolean
required
allow_mentions
boolean
required
manage_messages
boolean
required
pinable
boolean
required
share_links
boolean
required
share_Attachments
boolean
required
Example
{
"class": "blue",
"title": "Manager 2",
"order": 1,
"server_permissions": {
"server_administrator": false,
"allow_dm": false,
"create_invite": false,
"warn_members": false,
"suspend_members": false,
"ban_members": false,
"broadcast_messages": false,
"overwrite_language": false
},
"channel_permissions": {
"post_messages": true,
"attach_files": true,
"allow_mentions": true,
"manage_messages": true,
"pinable": true,
"share_links": true,
"share_Attachments": true
}
}Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://rai-api.returning.ai/api/v1/roles' \
--header 'x-api-key: {{x-api-key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"class": "blue",
"title": "Manager 2",
"order": 1,
"server_permissions": {
"server_administrator": false,
"allow_dm": false,
"create_invite": false,
"warn_members": false,
"suspend_members": false,
"ban_members": false,
"broadcast_messages": false,
"overwrite_language": false
},
"channel_permissions": {
"post_messages": true,
"attach_files": true,
"allow_mentions": true,
"manage_messages": true,
"pinable": true,
"share_links": true,
"share_Attachments": true
}
}'Responses
🟢200Success
application/json
Body
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
server_permissions
object
required
channel_permissions
object
required
class
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",
"server_permissions": {
"allow_dm": true,
"create_invite": true,
"kick_members": true,
"ban_members": true,
"manage_roles": true,
"manage_channels": true,
"server_administrator": true,
"_id": "{_id}"
},
"channel_permissions": {
"view_message_history": true,
"manage_messages": true,
"allow_mentions": true,
"post_messages": true,
"post_analysis": true,
"attach_files": true,
"_id": "{_id}"
},
"class": "red",
"serverId": "{_id}",
"_id": "{_id}",
"createdAt": "2024-08-06T03:56:39.162Z",
"updatedAt": "2024-08-06T03:56:39.162Z",
"__v": 0
}
}Modified at 2025-06-06 08:07:41