Loyalty Program

Update Loyalty Settings

put/v1/loyalty/{loyalty_settings_id}

Path parameters

loyalty_settings_idstring required

Request body

namestring

keystring

descriptionstring

custom_icon_urlstring uri

activated_atinteger

end_atinteger

periodinteger

repeatableboolean

points_ratenumber

price_source'local_price' | 'base_price'

excluded_sales_channelsOrderSourceType[] nullable

The list of Order Sources (sales channels) where paid orders will not issue Loyalty Points

show_store_buttonboolean

Response

Successful Response

namestring required

The name of the loyalty program

keystring nullable

External key of the loyalty program

descriptionstring nullable

A brief description of the loyalty program

custom_icon_urlstring uri nullable

Custom icon URL for loyalty points

activated_atinteger nullable

Timestamp when the program was activated (UNIX time)

end_atinteger nullable

Timestamp when the program ends (UNIX time)

periodinteger required

The duration of the loyalty program in days

repeatableboolean

Whether the program is repeatable

points_ratenumber required

Exchange rate against the dollar

price_source'local_price' | 'base_price'

excluded_sales_channelsOrderSourceType[] nullable

The list of Order Sources (sales channels) where paid orders will not issue Loyalty Points

show_store_buttonboolean

Whether to show the 'Go to Store' button in the loyalty program widget

idstring required

The unique identifier for the loyalty tier

game_idstring required

The unique identifier of the game the accosiated with the loyalty program

Changes

No recorded changes to this endpoint across all 15 revisions of this API.