Delete leaderboards

Delete leaderboards by ID.

DELETE /leaderboards

JavaScript

JavaScript

import { TrophyApiClient } from '@trophyso/node';

const trophy = new TrophyApiClient({
  apiKey: 'YOUR_API_KEY'
});

const response = await trophy.admin.leaderboards.delete({
  ids: [
    '550e8400-e29b-41d4-a716-446655440100',
    '550e8400-e29b-41d4-a716-446655440101'
  ]
});

from trophy import TrophyApi

client = TrophyApi(api_key='YOUR_API_KEY')

response = client.admin.leaderboards.delete(
  ids=[
    '550e8400-e29b-41d4-a716-446655440100',
    '550e8400-e29b-41d4-a716-446655440101'
  ]
)

import (
  "context"

  api "github.com/trophyso/trophy-go"
  trophyclient "github.com/trophyso/trophy-go/client"
  "github.com/trophyso/trophy-go/option"
)

client := trophyclient.NewClient(
  option.WithApiKey("YOUR_API_KEY"),
)

response, err := client.Admin.Leaderboards.Delete(context.TODO(), nil)

curl --request DELETE \
  --url https://admin.trophy.so/v1/leaderboards \
  --header 'X-API-KEY: <api-key>'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://admin.trophy.so/v1/leaderboards",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.delete("https://admin.trophy.so/v1/leaderboards")
  .header("X-API-KEY", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://admin.trophy.so/v1/leaderboards")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "deleted": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "issues": [
    {
      "severity": "warning",
      "message": "Would exceed maximum freeze limit",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "userId": "user-123",
      "boostId": "550e8400-e29b-41d4-a716-446655440000",
      "index": 0
    }
  ]
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Authorizations

X-API-KEY · string · header · required

Headers

Tenant-ID · string

The tenant identifier for multi-tenant organisations. Required when the organisation has multi-tenancy enabled. Pass your own internal customer ID for the tenant. Ignored for single-tenant organisations.

Query Parameters

ids · string<uuid>[] · required

Leaderboard IDs to delete. Repeat the query param or provide a comma-separated list.

Required array length: 1 - 100 elements

Response

200

application/json

Successful operation

Response containing deleted leaderboards represented by ID and any per-item issues.

deleted · DeletedResource · object[] · required

Array of deleted leaderboards represented by ID.

Show child attributes

issues · AdminIssue · object[] · required

Array of issues encountered during leaderboard deletion.

Show child attributes