Update points systems

Update points systems by ID.

PATCH /points

JavaScript

JavaScript

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

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

const result = await trophy.admin.points.systems.update([
  {
    id: 'system-uuid',
    name: 'New Name',
    description: 'Updated description'
  }
]);

from trophy import TrophyApi

client = TrophyApi(api_key='YOUR_API_KEY')

result = client.admin.points.systems.update(
  request=[{
    "id": "system-uuid",
    "name": "New Name",
    "description": "Updated description"
  }]
)

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.Systems.Update(context.TODO(), api.UpdatePointsSystemsRequest{})

curl --request PATCH \
  --url https://admin.trophy.so/v1/points \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "New Name"
  }
]
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://admin.trophy.so/v1/points",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    [
        'id' => '550e8400-e29b-41d4-a716-446655440000',
        'name' => 'New Name'
    ]
  ]),
  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.patch("https://admin.trophy.so/v1/points")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n    \"name\": \"New Name\"\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "[\n  {\n    \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n    \"name\": \"New Name\"\n  }\n]"

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

200

{
  "updated": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "New Name",
      "key": "xp",
      "description": "",
      "status": "active",
      "badge": null,
      "maxPoints": null
    }
  ],
  "issues": []
}

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

Body

application/json

Array of points system updates. Maximum 100 systems per request.

Required array length: 1 - 100 elements

id · string<uuid> · required

The UUID of the points system to update.

Example:

"550e8400-e29b-41d4-a716-446655440000"

name · string

Updated name.

description · string

Updated description.

badge · object | null

Updated badge. Set to null to remove.

Show child attributes

maxPoints · integer | null

Updated max points. Set to null to remove.

Required range: x >= 1

Response

200

application/json

Successful operation

Response containing updated points systems and any per-item issues.

updated · AdminPointsSystem · object[] · required

Array of successfully updated points systems.

Show child attributes

issues · AdminIssue · object[] · required

Array of issues encountered during update.

Show child attributes