Returning.AI
  1. Badge
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
      • update role
      • delete role
      • add role to a user on a server
      • remove role from a user on a server
      • get role list of user on a server
    • Channel
      • get channels list
      • create new channel
      • update channel
      • delete channel
    • Badge
      • get badges list
        GET
      • create new badge
        POST
      • update badge
        PUT
      • delete badge
        DELETE
      • award badge to user
        POST
      • remove badge from user
        POST
    • Integration
      • users
        • create new user
      • Messages
        • Send Message
        • Reply Message
      • Channels
        • Get Channels List
  1. Badge

award badge to user

Developing
POST
/badges/{id}/award

Request

Path Params
id
string 
required
Example:
b3df14ee-a674-480b-be2a-3f32c9d3a1d9
Header Params
x-api-key
string 
required
Body Params application/json
userId
string 
required
Example
{
    "userId": "1"
}

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/badges/b3df14ee-a674-480b-be2a-3f32c9d3a1d9/award' \
--header 'x-api-key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "userId": "1"
}'

Responses

🟢200Success
application/json
Body
meta
object 
required
success
boolean 
required
message
string 
required
devMessage
string 
required
body
array [object {8}] 
required
title
string 
optional
action
string 
optional
quantity
string 
optional
description
string 
optional
attachRequired
string 
optional
awarded
string 
optional
id
string 
optional
image
string 
optional
Example
{
    "meta": {
        "success": true,
        "message": "Badge has been rewarded successfully",
        "devMessage": "Badge has been rewarded successfully"
    },
    "body": [
        {
            "title": "Major",
            "action": "custom",
            "quantity": "3",
            "description": "One trade on a live account that makes 30%. Send account statement to #Tickmill-badge channel",
            "attachRequired": "true",
            "awarded": "true",
            "id": "{_id}",
            "image": "https://chartsnapshot.s3.amazonaws.com/apireturningai/tester/1721891103626-d763c952a89131696dd3bdf79fa0108.png"
        }
    ]
}
Previous
delete badge
Next
remove badge from user