Create points levels

Create points levels. Maximum 100 levels per request.

POST /points/{systemId}/levels

JavaScript

JavaScript

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

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

const result = await trophy.admin.points.levels.create('system-uuid', [
  {
    name: 'Bronze',
    key: 'bronze',
    points: 100,
    description: 'Starting level',
    badge: { url: 'https://example.com/bronze.png' }
  }
]);

from trophy import TrophyApi

client = TrophyApi(api_key='YOUR_API_KEY')

result = client.admin.points.levels.create(
  system_id='system-uuid',
  request=[{
    "name": "Bronze",
    "key": "bronze",
    "points": 100,
    "description": "Starting level",
    "badge": {"url": "https://example.com/bronze.png"}
  }]
)

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.Points.Levels.Create(context.TODO(), "system-uuid", api.CreatePointsLevelsRequest{})

curl --request POST \
  --url https://admin.trophy.so/v1/points/{systemId}/levels \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
[
  {
    "name": "Bronze",
    "key": "bronze",
    "points": 100,
    "description": "Starting level"
  }
]
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://admin.trophy.so/v1/points/{systemId}/levels",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    [
        'name' => 'Bronze',
        'key' => 'bronze',
        'points' => 100,
        'description' => 'Starting level'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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.post("https://admin.trophy.so/v1/points/{systemId}/levels")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"name\": \"Bronze\",\n    \"key\": \"bronze\",\n    \"points\": 100,\n    \"description\": \"Starting level\"\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://admin.trophy.so/v1/points/{systemId}/levels")

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

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "[\n  {\n    \"name\": \"Bronze\",\n    \"key\": \"bronze\",\n    \"points\": 100,\n    \"description\": \"Starting level\"\n  }\n]"

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

200

{
  "created": [],
  "issues": [
    {
      "index": 0,
      "severity": "error",
      "message": "Key already in use by another level"
    }
  ]
}

{
  "created": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Bronze",
      "key": "bronze",
      "points": 100,
      "description": "Starting level",
      "badge": {
        "url": "https://example.com/bronze.png"
      }
    }
  ],
  "issues": []
}

{
  "error": "<string>"
}

{
  "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.

Path Parameters

systemId · string<uuid> · required

The UUID of the points system.

Body

application/json

Array of levels to create. Maximum 100 levels per request.

Required array length: 1 - 100 elements

name · string · required

The name of the level.

Example:

"Bronze"

key · string · required

A unique key for the level. Only alphanumeric characters, hyphens, and underscores are permitted.

Pattern: ^[a-zA-Z\d-_]+$

Example:

"bronze"

points · integer · required

The threshold points value for the level.

Required range: x >= 0

Example:

100

description · string

An optional description of the level.

Example:

"Starting level"

badge · object

An optional badge for the level.

Show child attributes

Response

200

application/json

Successful operation (no levels created)

Response containing created levels and any per-item issues.

created · AdminPointsLevel · object[] · required

Array of successfully created levels.

Show child attributes

issues · AdminIssue · object[] · required

Array of issues encountered during level creation.

Show child attributes