Skip to main content
POST
Grant Items 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

This function directly adds inventory items to the user's inventories. As a result of this operations, the user will not be charged any transaction fee, regardless of the inventory item catalog definition. Please note that the processing time for inventory grants and purchases increases fractionally the more items are in the inventory, and the more items are in the grant/purchase operation.

This function directly adds inventory items to the user's inventories. As a result of this operations, the user will not be charged any transaction fee, regardless of the inventory item catalog definition. Please note that the processing time for inventory grants and purchases increases fractionally the more items are in the inventory, and the more items are in the grant/purchase operation.

ItemIds
string[]
required

Array of itemIds to grant to the user.

PlayFabId
string
required

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

Annotation
string

String detailing any additional information concerning this operation.

CatalogVersion
string

Catalog version from which items are to be granted.

CustomTags
object

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

Response

Please note that the order of the items in the response may not match the order of items in the request.

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

Please note that the order of the items in the response may not match the order of items in the request.

Example:
Last modified on October 1, 2026