Skip to main content
POST
Unlock Container Instance

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 container and optionally the catalogVersion for the container to open

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

ContainerItemInstanceId
string
required

ItemInstanceId of the container 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 catalog associated with the item instance.

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.).

KeyItemInstanceId
string

ItemInstanceId of the key that will be consumed by unlocking this container. If the container requires a key, this parameter is required.

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