Skip to main content
POST
JavaScript

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 systems to create. Maximum 100 systems per request.

Required array length: 1 - 100 elements
name
string
required

The points system name.

Example:

"XP"

key
string
required

The points system key. Only alphanumeric characters, hyphens, and underscores are permitted.

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

"xp"

description
string

A short description of the points system.

Example:

"Experience points"

badge
object | null

An optional badge for the points system.

maxPoints
integer | null

Optional maximum points a user can earn.

Required range: x >= 1
levels
CreatePointsLevelRequestItem · object[]

Optional array of levels to create alongside the system.

boosts
CreatePointsBoostRequestItem · object[]

Optional array of boosts to create alongside the system.

triggers
CreatePointsTriggerRequestItem · object[]

Optional array of triggers to create alongside the system.

Response

Successful operation (no systems created)

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

created
CreatedAdminPointsSystem · object[]
required

Array of successfully created points systems.

issues
AdminIssue · object[]
required

Array of issues encountered during creation.