Grant Character To User
Grants the specified character type to the user. CharacterIds are not globally unique; characterId must be evaluated with the parent PlayFabId to guarantee uniqueness.
Error codes
This operation may return the following PlayFab errors:
| Error | Code |
|---|---|
| InvalidItemProperties | 1091 |
| ItemNotOwned | 1048 |
Authorizations
This API requires a client session ticket, available from any Client Login function.
Body
Grants a character to the user of the type specified by the item ID. The user must already have an instance of this item in their inventory in order to allow character creation. This item can come from a purchase or grant, which must be done before calling to create the character.
Grants a character to the user of the type specified by the item ID. The user must already have an instance of this item in their inventory in order to allow character creation. This item can come from a purchase or grant, which must be done before calling to create the character.
Non-unique display name of the character being granted (1-40 characters in length).
Catalog item identifier of the item in the user's inventory that corresponds to the character in the catalog to be created.
Catalog version from which items are to be granted.
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
