Skip to main content
PATCH
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.

Path Parameters

systemId
string<uuid>
required

The UUID of the points system.

Body

application/json

Array of boost patches.

Required array length: 1 - 100 elements
id
string<uuid>
required

The UUID of the boost to update.

name
string

Updated name for the boost.

Maximum string length: 255
start
string<date>

Updated start date (YYYY-MM-DD).

end
string<date> | null

Updated end date (YYYY-MM-DD) or null to remove end date.

multiplier
number

Updated points multiplier.

rounding
enum<string>

Updated rounding strategy.

Available options:
down,
up,
nearest
userAttributes
object[] | null

Updated user attribute filters. Cannot be set on user-specific boosts. Set to null to clear.

Response

Successful operation

Response containing updated boosts and any issues encountered.

updated
AdminPointsBoost · object[]
required

Array of successfully updated boosts.

issues
AdminIssue · object[]
required

Array of issues encountered during boost updates.