Skip to main content
PATCH
/
community
/
{id}
/
experience
/
{experienceId}
/
leaderboard
Update experience leaderboard configuration
curl --request PATCH \
  --url https://api.op.xyz/v1/community/{id}/experience/{experienceId}/leaderboard \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "badgeId": "<string>",
  "metric": "<string>",
  "direction": "ASC",
  "totalPlays": 123,
  "prizes": [
    {
      "name": "<string>",
      "description": "<string>",
      "imageUrl": "<string>"
    }
  ]
}
'
{
  "badgeId": "<string>",
  "metric": "<string>",
  "direction": "ASC",
  "totalPlays": 123,
  "prizes": [
    {
      "name": "<string>",
      "description": "<string>",
      "imageUrl": "<string>"
    }
  ]
}

Authorizations

X-Api-Key
string
header
required

Path Parameters

id
string
required

Community ID

experienceId
string
required

Body

application/json
badgeId
string
metric
string

The metric to use for the leaderboard. This key must be present in the badge metadata.

direction
enum<string>
Available options:
ASC,
DESC
totalPlays
number
prizes
object[]

Response

The experience leaderboard has been successfully updated

badgeId
string
required
metric
string
required

The metric to use for the leaderboard. This key must be present in the badge metadata.

direction
enum<string>
required
Available options:
ASC,
DESC
totalPlays
number
prizes
object[]