Skip to main content
POST
Unlock Container Item

Authorizations

X-SecretKey
string
header
required

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

Body

application/json

Specify the type of container to open and optionally the catalogVersion for the container to open

Specify the type of container to open and optionally the catalogVersion for the container to open

ContainerItemId
string
required

Catalog ItemId of the container type to unlock.

PlayFabId
string
required

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

CatalogVersion
string

Specifies the catalog version that should be used to determine container contents. If unspecified, uses default/primary catalog.

CharacterId
string

Unique PlayFab assigned ID for a specific character owned by a user

CustomTags
object

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

Response

The items and vc found within the container. These will be added and stacked in your inventory as appropriate.

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

The items and vc found within the container. These will be added and stacked in your inventory as appropriate.

Example:
Last modified on October 1, 2026