Skip to main content
POST
Grant Character To User

Authorizations

X-SecretKey
string
header
required

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Body

application/json

Grants a character to the user of the type and name specified in the request.

Grants a character to the user of the type and name specified in the request.

CharacterName
string
required

Non-unique display name of the character being granted (1-40 characters in length).

CharacterType
string
required

Type of the character being granted; statistics can be sliced based on this value.

PlayFabId
string
required

Unique PlayFab assigned ID of the user on whom the operation will be performed.

CustomTags
object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Response

code
integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status
string

The Http status code as a string.

data
object
Example:
Last modified on October 1, 2026