Account Management - Set Profile Language

Reference

Service:: Profiles

API Version:: 240412

Updates the entity's language. The precedence hierarchy for communication to the player is Title Player Account language, Master Player Account language, and then title default language if the first two aren't set or supported.

POST https://titleId.playfabapi.com/Profile/SetProfileLanguage

Request Header

Name	Required	Type	Description
X-EntityToken	True	string	This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Request Body

Name	Type	Description
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Entity	EntityKey	The optional entity to perform this action on. Defaults to the currently logged in entity.
ExpectedVersion	number	The expected version of a profile to perform this update on
Language	string	The language to set on the given entity. Deletes the profile's language if passed in a null string.

Responses

Name	Type	Description
200 OK	SetProfileLanguageResponse
400 Bad Request	ApiErrorWrapper	This is the outer wrapper for all responses with errors

Security

X-EntityToken

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Type: apiKey
In: header

Definitions

Name	Description
ApiErrorWrapper	The basic wrapper around every failed API response
EntityKey	Combined entity type and ID structure which uniquely identifies a single entity.
OperationTypes
SetProfileLanguageRequest	Given an entity profile, will update its language to the one passed in if the profile's version is equal to the one passed in.
SetProfileLanguageResponse

ApiErrorWrapper

The basic wrapper around every failed API response

Name	Type	Description
code	integer	Numerical HTTP code
error	string	Playfab error code
errorCode	integer	Numerical PlayFab error code
errorDetails	object	Detailed description of individual issues with the request object
errorMessage	string	Description for the PlayFab errorCode
status	string	String HTTP code

EntityKey

Combined entity type and ID structure which uniquely identifies a single entity.

Name	Type	Description
Id	string	Unique ID of the entity.
Type	string	Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types

OperationTypes

Name	Type	Description
Created	string
Deleted	string
None	string
Updated	string

SetProfileLanguageRequest

Given an entity profile, will update its language to the one passed in if the profile's version is equal to the one passed in.

Name	Type	Description
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Entity	EntityKey	The optional entity to perform this action on. Defaults to the currently logged in entity.
ExpectedVersion	number	The expected version of a profile to perform this update on
Language	string	The language to set on the given entity. Deletes the profile's language if passed in a null string.

SetProfileLanguageResponse

Name	Type	Description
OperationResult	OperationTypes	The type of operation that occured on the profile's language
VersionNumber	number	The updated version of the profile after the language update