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
        • 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
      • Users
        • Get user
      • Community Users
        • Get community users
        • Get community 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. Badge

update badge

Developing
PUT
/badges/{id}

Request

Path Params
id
string 
required
Example:
84845081-98fd-46f3-96aa-1032174e58a5
Header Params
x-api-key
string 
required
Body Params application/json
title
string 
required
action
string 
required
quantity
integer 
required
image
string 
required
description
string 
required
darkImage
string 
required
lightImage
string 
required
enabledDarkAndLight
boolean 
required
award
boolean 
required
awardCurrency
boolean 
required
awardXpQuantity
integer 
required
awardCurrencyQuantity
integer 
required
attachRequired
boolean 
required
Example
{
    "title": "It's title",
    "action": "custom",
    "quantity": 100,
    "image": "",
    "description": "This is description",
    "darkImage": "",
    "lightImage": "",
    "enabledDarkAndLight": true,
    "award": true,
    "awardCurrency": true,
    "awardXpQuantity": 100,
    "awardCurrencyQuantity": 100,
    "attachRequired": 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/badges/84845081-98fd-46f3-96aa-1032174e58a5' \
--header 'x-api-key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "title": "It'\''s title",
    "action": "custom",
    "quantity": 100,
    "image": "",
    "description": "This is description",
    "darkImage": "",
    "lightImage": "",
    "enabledDarkAndLight": true,
    "award": true,
    "awardCurrency": true,
    "awardXpQuantity": 100,
    "awardCurrencyQuantity": 100,
    "attachRequired": true
}'

Responses

🟢200Success
application/json
Body
meta
object 
required
success
boolean 
required
message
string 
required
devMessage
string 
required
body
object 
required
title
string 
required
action
string 
required
quantity
string 
required
description
string 
required
attachRequired
string 
required
awarded
string 
required
id
string 
required
image
string 
required
Example
{
    "meta": {
        "success": true,
        "message": "Badge has been updated successfully",
        "devMessage": "Badge has been updated 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.us-east-2.amazonaws.com/apireturningai/tester/1721927206522-d763c952a89131696dd3bdf79fa0108.png"
    }
}
Modified at 2025-06-05 12:14:16
Previous
create new badge
Next
delete badge