Award badge to user
Deprecated
POST
/badges/{id}/award
/badges/{id}/award with the documented body, query parameters, headers, or multipart fields. Prefer the newer authenticated /v1/... integration API where available.{ status, message, data } wrapper.400 invalid request body, query, ObjectId, pagination, file format, or missing required field.401 missing, invalid, expired, or insufficient API key/token.403 key is valid but cannot access this community/channel/user/resource, where supported by the service.404 route or target resource was not found. Several legacy root routes returned 404 on https://api.returning.ai during smoke testing and need backend confirmation before external use.409 duplicate or conflicting state for create/update operations, where applicable.500 unexpected Returning.AI service error.Compatibility endpoint retained for older integrations. Do not use this endpoint for new integrations unless Returning.AI specifically tells you to maintain a legacy flow. Prefer the current
/v1/... endpoint in the matching non-Legacy category when one exists.Request
Path Params
Header Params
Body Params application/json
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.returning.ai/badges/b3df14ee-a674-480b-be2a-3f32c9d3a1d9/award' \
--header 'x-api-key;' \
--header 'Content-Type: application/json' \
--data '{
"userId": "1"
}'Response Response Example
200 - Success 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"
}
]
}Modified at 2026-05-18 17:03:37