Skip to main content

Player locale attribute

What's new

Players have a new optional locale attribute. It takes one of the codes from the Locale enum, such as en, pt-BR, or zh-Hant. See Locales for the full list.

Impact

You can store a player's language alongside their other attributes, either directly on the player or through the player_info you send when creating an order or authorizing a user. The value comes back wherever player attributes are returned, including the player_info on orders.

Webhook payloads carry the same attribute in context.player.attributes.locale on every event.

Changes

ResourceChange
update_playerAdded optional attributes.locale to the request
upsert_playerAdded optional attributes.locale to the request and response
get_playerAdded optional attributes.locale to the response
create_orderAdded optional player_info.attributes.locale to the request
get_orderAdded optional player_info.attributes.locale to the response
update_orderAdded optional player_info.attributes.locale to the response
authorize_userAdded optional player_info.attributes.locale to the request

Upgrade

  • Nothing is required. The attribute is optional and existing requests keep working.
  • To use it, send locale in player attributes with a value from the Locale enum.

Need help?
Contact our integration team at [email protected]