Achievements7

Coupons7

Creators8

Daily Rewards6

Disputes1

Fraud Alerts1

GDPR Requests2

Item Categories7

Items9

Leaderboards8

LiveOps10

Locales5

Loyalty Program5

News7

Orders6

Pages8

Payments1

Payments' Dispute Evidence3

Players6

Players' Marketing Consents2

Players' Store Items1

Players' Subscriptions5

Price Points1

Price Templates5

Segmentation11

Store Promotions9

Stores15

Translation Glossaries5

Users6

Videos5

Webhooks7

Store Promotions

Create Store Promotion

post/v1/store_promotions

Request body

namestring

The name of the promotion

start_atinteger nullable

The start date of the promotion in seconds when the promotion starts to be applied

end_atinteger nullable

The end date of the promotion in seconds when the promotion ends to be applied

discount_percentinteger

The discount percent of the promotion

bonus_percentinteger

The bonus percent of the promotion for a stackable items

max_purchase_countinteger

The maximum purchase count of the promotion. If the user exceeds this count, the promotion will not be applied.

max_purchase_count_per_userinteger

The maximum purchase count per user. If the user exceeds this count, the promotion will not be applied. This setting is mutually exclusive with 'max_purchase_count'

reward_points_percentnumber

The rewards points percent of the promotion

reward_points_fixedinteger

The fixed rewards points amount

loyalty_points_percentinteger

The loyalty points percent of the promotion

loyalty_points_fixedinteger

The fixed loyalty points amount

store_idsstring[]

Store ids that the promotion is applied to

item_idsstring[]

Item ids that the promotion is applied to

category_idsstring[]

Category ids that the promotion is applied to

exclude_items_for_reward_pointsboolean

Turn off discount benefit for items that can be purchased with reward points

bonus_item_percentinteger

The user will receive a quantity equivalent to the set percentage of the total USD (in cents) purchase.

bonus_item_idstring

The item ID that the user will receive a quantity equivalent to the set percentage of the total USD (in cents) purchase.

bonus_item_quantityinteger

The fixed quantity of the bonus item

item_background_image_urlstring uri nullable

Background image URL to override item background during the promotion

item_featured_card_background_image_urlstring uri nullable

Featured card background image URL to override item featured card background during the promotion

activeboolean

Allows to enable or disable the promotion

archived_atinteger

The date when the promotion is archived in seconds

bonus_badgestring

Custom text for store items bonus badge during the promotion

custom_badgestring

Custom text to override store items custom badge during the promotion

apply_to_free_itemsboolean

Whether the promotion should be applied to free items

Response

Successful Response

namestring

The name of the promotion

start_atinteger nullable

The start date of the promotion in seconds when the promotion starts to be applied

end_atinteger nullable

The end date of the promotion in seconds when the promotion ends to be applied

discount_percentinteger

The discount percent of the promotion

bonus_percentinteger

The bonus percent of the promotion for a stackable items

max_purchase_countinteger

The maximum purchase count of the promotion. If the user exceeds this count, the promotion will not be applied.

max_purchase_count_per_userinteger

The maximum purchase count per user. If the user exceeds this count, the promotion will not be applied. This setting is mutually exclusive with 'max_purchase_count'

reward_points_percentnumber

The rewards points percent of the promotion

reward_points_fixedinteger

The fixed rewards points amount

loyalty_points_percentinteger

The loyalty points percent of the promotion

loyalty_points_fixedinteger

The fixed loyalty points amount

store_idsstring[]

Store ids that the promotion is applied to

item_idsstring[]

Item ids that the promotion is applied to

category_idsstring[]

Category ids that the promotion is applied to

exclude_items_for_reward_pointsboolean

Turn off discount benefit for items that can be purchased with reward points

bonus_item_percentinteger

The user will receive a quantity equivalent to the set percentage of the total USD (in cents) purchase.

bonus_item_idstring

The item ID that the user will receive a quantity equivalent to the set percentage of the total USD (in cents) purchase.

bonus_item_quantityinteger

The fixed quantity of the bonus item

item_background_image_urlstring uri nullable

Background image URL to override item background during the promotion

item_featured_card_background_image_urlstring uri nullable

Featured card background image URL to override item featured card background during the promotion

activeboolean

Allows to enable or disable the promotion

archived_atinteger

The date when the promotion is archived in seconds

bonus_badgestring

Custom text for store items bonus badge during the promotion

custom_badgestring

Custom text to override store items custom badge during the promotion

apply_to_free_itemsboolean

Whether the promotion should be applied to free items

idstring required

created_atinteger required

current_purchase_countinteger required

user_idstring

campaign_idstring

user_campaign_idstring

Changes

Changed in 2 of the 28 revisions of this API.73

Sep 23, 20261816e2044c0713See the full diff
- ●
  added the new function enum value to the /// response property for the response status
  response-property-enum-value-added
- ○
  added the new optional request property /
  new-optional-request-property
- ○
  added the new function enum value to the request property ///
  request-property-enum-value-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 20, 20268662e77bc1e26See the full diff
- ●
  the request property's maxLength was set to 32
  request-property-max-length-set
- ●
  the /// request property's maxLength was set to 32
  request-property-max-length-set
- ●
  the / request property's maxLength was set to 32
  request-property-max-length-set
- ●
  the / request property's maxLength was set to 32
  request-property-max-length-set
- ●
  the /// request property's maxLength was set to 32
  request-property-max-length-set
- ●
  the / request property's maxLength was set to 32
  request-property-max-length-set
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog