Characters - Grant Character To User

Service:

Server

API Version:

241122

Grants the specified character type to the user. CharacterIds are not globally unique; characterId must be evaluated with the parent PlayFabId to guarantee uniqueness.

POST https://titleId.playfabapi.com/Server/GrantCharacterToUser

Request Header

Name	Required	Type	Description
X-SecretKey	True	string	This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Request Body

Name	Required	Type	Description
CharacterName	True	string	Non-unique display name of the character being granted (1-40 characters in length).
CharacterType	True	string	Type of the character being granted; statistics can be sliced based on this value.
PlayFabId	True	string	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.).

Responses

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

Security

X-SecretKey

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

Type: apiKey
In: header

Definitions

Name	Description
ApiErrorWrapper	The basic wrapper around every failed API response
GrantCharacterToUserRequest	Grants a character to the user of the type and name specified in the request.
GrantCharacterToUserResult

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

GrantCharacterToUserRequest

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

Name	Type	Description
CharacterName	string	Non-unique display name of the character being granted (1-40 characters in length).
CharacterType	string	Type of the character being granted; statistics can be sliced based on this value.
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
PlayFabId	string	Unique PlayFab assigned ID of the user on whom the operation will be performed.

GrantCharacterToUserResult

Name	Type	Description
CharacterId	string	Unique identifier tagged to this character.