Passer au contenu principal
POST
Unlock Container Instance

Autorisations

X-Authorization
string
header
requis

This API requires a client session ticket, available from any Client Login function.

Corps

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
requis

ItemInstanceId of the container to unlock.

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.

Réponse

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

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 the appropriate inventory.

Exemple:
Dernière modification le 6 octobre 2026