Returning.AI
  1. Role
Returning.AI
  • Returning.AI
    • Auth
      • secure auth
      • register
      • verify email
      • login
    • 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
        • Get User Data
        • Get Users with Filters
        • Manage User account
        • Get User Gamification History
        • Get User Gamification Stats
        • Bulk Import
        • Bulk Update
      • Messages
        • Send Message
        • Reply Message
        • React Message
      • Channels
        • Get Channels List
      • User Api Key
        • Get User Api Key
        • Post User Api Key
        • Update User Api Key
        • Delete Endpoint
        • api key info
    • Application
      • 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

add role to a user on a server

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

Request

Path Params

Header Params

Request Code 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

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": []
    }
}
Modified at 2025-05-22 06:02:22
Previous
delete role
Next
remove role from a user on a server