TagMangoTagMango Docs
Gamification

Assign Badges To User

PATCH
/api/v1/external/gamification/badges/{userId}/assign

Assign badges to a user.

  • This endpoint can be used to assign badges to a user.
  • It doesn't support revoking badges.

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

userId*string

Unique identifier of the subscriber

Header Parameters

x-whitelabel-host*string

Host name of the dashboard, ex: mydomain.tagmango.com

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X PATCH "https://api-prod-new.tagmango.com/api/v1/external/gamification/badges/646dd0eb159d8b7a7f5a9c29/assign" \  -H "x-whitelabel-host: string" \  -H "Content-Type: application/json" \  -d '{    "badges": [      "6657092c8142bfe0656481bf",      "6659cac25f2acb7abfdcdb20",      "66617711715449eae2f4e096"    ]  }'
{
  "message": "Operation completed successfully",
  "success": true
}
{
  "code": 400,
  "type": "Bad request",
  "statusMessage": "BAD_REQUEST",
  "message": "Invalid request",
  "success": false
}
{
  "code": 401,
  "type": "Unauthorized",
  "statusMessage": "UNAUTHORIZED",
  "message": "Invalid token",
  "success": false
}

Update Badge PATCH

Update badge by using identifier. - If automation is enabled, then the badge will be assigned to the users automatically. - Automation may take time to reflect. There are two types of badges automation - 1. Automation by points threshold - When user reaches this points threshold, the badge will be assigned to the user automatically, if points fall below the threshold then it will be removed from the user. 2. Automation by mango subscription - When user subscribes to any of these mangoes, then the badge will be assigned to the user automatically. If subscription expired or removed then it will be removed from the user. **Note** Only one of the automation type can be enabled at a time.

Get App Configurations GET

Get app configurations for host. - This endpoint can be used to get app configurations for a host. - It can be used to get allowed mangoes for an app. :::info - Currently only supports these apps levelup, universe, crm, flute, sparks, tm-ai-cofounder. - These apps must be installed to the dashboard first before accessing this endpoint. - Any custom app added from Dashboard will not be supported. :::