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
      • Messages
        • Send Message
        • Reply Message
      • Channels
        • Get Channels List
  1. Role

add role to a user on a server

Developing
POST
/roles/{userId}/{roleId}/add

Request

Path Params
userId
string 
required
Example:
1106
roleId
string 
required
Example:
682d69d6f91d6de701b91391
Header Params
x-api-key
string 
required

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/1106/682d69d6f91d6de701b91391/add' \
--header 'x-api-key;'

Responses

🟢200Success
application/json
Body
meta
object 
required
success
boolean 
required
message
string 
required
devMessage
string 
required
body
object 
required
_id
string 
required
name
string 
required
email
string 
required
displayname
string 
required
first
string 
required
last
string 
required
nicename
string 
required
signup_date
string 
required
last_login
string 
required
isVerified
boolean 
required
joinServer
boolean 
required
createdAt
string 
required
updatedAt
string 
required
id
string 
required
__v
integer 
required
badges
object 
required
server_roles
array[string]
required
Example
{
    "meta": {
        "success": true,
        "message": "Role has been added to user successfully",
        "devMessage": "Role has been added to user successfully"
    },
    "body": {
        "_id": "{_id}",
        "name": "Reti Him",
        "email": "lazosa@uiemail.com",
        "displayname": "lazosa",
        "first": "Reti",
        "last": "Him",
        "nicename": "lazosa",
        "signup_date": "2025-04-30T04:54:51.777Z",
        "last_login": "2025-04-30T08:27:33.138Z",
        "isVerified": true,
        "joinServer": true,
        "createdAt": "2025-04-30T04:54:51.780Z",
        "updatedAt": "2025-04-30T08:49:00.165Z",
        "id": "{id}",
        "__v": 0,
        "badges": {},
        "server_roles": []
    }
}
Previous
delete role
Next
remove role from a user on a server