- Returning.AI
- Auth
- Server
- Role
- Channel
- Badge
- Integration
create new badge
Developing
POST
/badges
Request
Header Params
x-api-key
string
required
Body Params application/json
title
string
required
action
string
required
quantity
integer
optional
image
string
optional
applied
boolean
optional
awarded
boolean
optional
description
string
optional
darkImage
string
optional
lightImage
string
optional
enabledDarkAndLight
boolean
optional
award
boolean
optional
awardCurrency
boolean
optional
awardXpQuantity
integer
optional
awardCurrencyQuantity
integer
optional
attachRequired
boolean
optional
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 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' \
--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
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 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"
}
}