Create points boosts

Create points boosts.

POST /points/{systemId}/boosts

JavaScript

JavaScript

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

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

const response = await trophy.admin.points.boosts.create('system-uuid', [
  {
    userId: 'user-123',
    name: 'Double XP Weekend',
    start: '2024-01-01',
    end: '2024-01-03',
    multiplier: 2
  },
  {
    name: 'Global Holiday Bonus',
    start: '2024-12-25',
    multiplier: 1.5,
    rounding: 'up'
  },
  {
    name: 'Premium User Boost',
    start: '2024-01-01',
    multiplier: 2,
    userAttributes: [
      { attributeId: 'attr-uuid', attributeValue: 'premium' }
    ]
  }
]);

from trophy import TrophyApi

client = TrophyApi(api_key='YOUR_API_KEY')

response = client.admin.points.boosts.create(
  system_id='system-uuid',
  boosts=[
    {
      "userId": "user-123",
      "name": "Double XP Weekend",
      "start": "2024-01-01",
      "end": "2024-01-03",
      "multiplier": 2
    },
    {
      "name": "Global Holiday Bonus",
      "start": "2024-12-25",
      "multiplier": 1.5,
      "rounding": "up"
    },
    {
      "name": "Premium User Boost",
      "start": "2024-01-01",
      "multiplier": 2,
      "userAttributes": [
        {"attributeId": "attr-uuid", "attributeValue": "premium"}
      ]
    }
  ]
)

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

curl --request POST \
  --url https://admin.trophy.so/v1/points/{systemId}/boosts \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
[
  {
    "userId": "user-123",
    "name": "Double XP Weekend",
    "start": "2024-01-01",
    "end": "2024-01-03",
    "multiplier": 2
  }
]
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://admin.trophy.so/v1/points/{systemId}/boosts",
  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([
    [
        'userId' => 'user-123',
        'name' => 'Double XP Weekend',
        'start' => '2024-01-01',
        'end' => '2024-01-03',
        'multiplier' => 2
    ]
  ]),
  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}/boosts")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"userId\": \"user-123\",\n    \"name\": \"Double XP Weekend\",\n    \"start\": \"2024-01-01\",\n    \"end\": \"2024-01-03\",\n    \"multiplier\": 2\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

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

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    \"userId\": \"user-123\",\n    \"name\": \"Double XP Weekend\",\n    \"start\": \"2024-01-01\",\n    \"end\": \"2024-01-03\",\n    \"multiplier\": 2\n  }\n]"

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

200

All requests had errors

{
  "created": [],
  "issues": [
    {
      "index": 0,
      "severity": "error",
      "message": "User does not exist"
    }
  ]
}

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 boosts to create.

Required array length: 1 - 100 elements

name · string · required

The name of the boost.

Maximum string length: 255

Example:

"Double XP Weekend"

start · string<date> · required

The start date of the boost (YYYY-MM-DD).

Example:

"2024-01-01"

multiplier · number · required

The points multiplier. Must be greater than 0, not equal to 1, and less than 100.

Example:

2

userId · string | null

The ID of the user to create a boost for. Mutually exclusive with userAttributes — providing userAttributes when userId is set will result in an error. Omit for a global boost.

Example:

"user-123"

end · string<date> | null

The end date of the boost (YYYY-MM-DD). If null, the boost has no end date.

Example:

"2024-01-03"

rounding · enum<string> · default: down

How to round the boosted points. Defaults to 'down'.

Available options: down, up, nearest

Example:

"down"

userAttributes · object[] | null

User attribute filters for the boost. Cannot be provided when userId is set.

Show child attributes

Example:

[
  {
    "attributeId": "550e8400-e29b-41d4-a716-446655440000",
    "attributeValue": "premium"
  }
]

Response

200

application/json

Successful operation (no boosts created)

Response containing created boosts and any issues encountered while creating points boosts.

created · AdminPointsBoost · object[] · required

Array of successfully created boosts.

Show child attributes

issues · AdminIssue · object[] · required

Array of issues encountered during boost creation.

Show child attributes