Returning.AI
  1. Role
Returning.AI
  • Returning.AI
    • Auth
      • register
      • verify email
      • login
      • secure auth
    • Server
      • create new server
      • get my servers
      • update server
      • role list of server
      • channel list of server
    • Role
      • create new role
        POST
      • update role
        PUT
      • delete role
        DELETE
      • add role to a user on a server
        POST
      • remove role from a user on a server
        POST
      • get role list of user on a server
        GET
    • Channel
      • get channels list
      • create new channel
      • update channel
      • delete channel
    • Badge
      • get badges list
      • create new badge
      • update badge
      • delete badge
      • award badge to user
      • remove badge from user
    • Integration
      • users
        • create new user
        • manage user
        • user data
        • gamification stats
        • user bulk update
        • user bulk import
      • Messages
        • Send Message
        • Reply Message
        • React Message
      • Channels
        • Get Channels List
      • User Field Histories
        • Create user field history
        • Get user field histories
      • User Fields
        • Create user field
        • Get all user fields for a community
        • Delete user field
        • Update user field
        • Get specific user field
      • Users
        • Get user
    • Application
      • API Keys
        • Create API key
        • Read API keys
        • Delete API key
        • Update API key
      • Users
        • Get user
      • Community Users
        • Get community users
        • Get user
      • User Fields
        • Get all user fields for a community
        • Get specific user field
        • Create user field
        • Update user field
        • Delete user field
      • User Field Histories
        • Get all user field histories in a community
        • Get user field histories for a specific field
        • Get user field histories for a specific user
        • Get user field histories of specific user field and user
        • Create user field history for specific user
  1. Role

update role

Developing
PUT
/roles/{id}

Request

Path Params
id
string 
required
Example:
682d61dfd843de46566c9eab
Header Params
x-api-key
string 
required
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,
    "billable": false,
    "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 PUT 'https://rai-api.returning.ai/api/v1/roles/682d61dfd843de46566c9eab' \
--header 'x-api-key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "class": "blue",
    "title": "Manager 2",
    "order": 1,
    "billable": false,
    "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
_id
string 
required
order
integer 
required
billable
boolean 
required
title
string 
required
description
string 
required
server_permissions
object 
required
channel_permissions
object 
required
class
string 
required
createdAt
string 
required
updatedAt
string 
required
__v
integer 
required
Example
{
    "meta": {
        "success": true,
        "message": "Role has been updated successfully",
        "devMessage": "Role has been updated successfully"
    },
    "body": {
        "_id": "{_id}",
        "order": 2,
        "billable": false,
        "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": "66a27b91fe1c879712142894"
        },
        "channel_permissions": {
            "view_message_history": true,
            "manage_messages": true,
            "allow_mentions": true,
            "post_messages": true,
            "post_analysis": true,
            "attach_files": true,
            "_id": "{_id}"
        },
        "class": "blue",
        "serverId": "{_id}",
        "createdAt": "2024-07-25T16:17:27.299Z",
        "updatedAt": "2024-07-25T16:21:37.761Z",
        "__v": 0
    }
}
Modified at 2025-06-06 08:52:14
Previous
create new role
Next
delete role