v1

latestOpenAPI 3.1.02026-07-24318141.2 MB

Create Reward Multiplier

post/{client_id}/reward-multipliers/

Path parameters

client_idstring required

Request body

namestring required
descriptionstring
multiplier_factorinteger required

Multiplier value applied to reward earnings (e.g. 2 = double rewards)

activation_type'user_activated' | 'automatic' required

Defines how the multiplier is activated (e.g. user activated or automatic).

active_durationstring

Duration for which the user activated multiplier remains active after activation, in ISO 8601 format.

started_atstring

UTC timestamp when the multiplier becomes available. The timestamp should not be in the past.

stopped_atstring

UTC timestamp when the multiplier expires and stops being available. The timestamp should not be in the past.

reward_item_idsstring[] required

List of reward item UUIDs that the multiplier applies to.

profile_group_idsstring[]

List of reward item UUIDs that the multiplier applies to.