Returning.AI
  1. Badge
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
      • 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
        • 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. Badge

update badge

Developing
PUT
/badges/{id}

Request

Path Params

Header Params

Body Params application/json

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

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