create new badge

Developing

POST

/badges

Request

Header Params

Body Params application/json

Example

{
    "title": "It's title",
    "action": "custom",
    "quantity": 100,
    "image": "",
    "description": "This is description",
    "darkImage": "",
    "lightImage": "",
    "awarded": false,
    "applied": false,
    "enabledDarkAndLight": false,
    "award": true,
    "awardCurrency": true,
    "awardXpQuantity": 100,
    "awardCurrencyQuantity": 100,
    "attachRequired": true
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://rai-api.returning.ai/api/v1/badges' \
--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": "",
    "awarded": false,
    "applied": false,
    "enabledDarkAndLight": false,
    "award": true,
    "awardCurrency": true,
    "awardXpQuantity": 100,
    "awardCurrencyQuantity": 100,
    "attachRequired": true
}'

Responses

🟢200Success

application/json

Body

Example

{
    "meta": {
        "success": true,
        "message": "Badge has been created successfully",
        "devMessage": "Badge has been created successfully"
    },
    "body": {
        "title": "General",
        "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-05-23 10:30:58

get badges list

update badge