Share via

Player Item Management - Revoke Inventory Items

  • Reference
Service:
Server
API Version:
241122

NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2. Revokes access for up to 25 items across multiple users and characters.

POST https://titleId.playfabapi.com/Server/RevokeInventoryItems

Request Header

Name Required Type Description
X-SecretKey True

string

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

Request Body

Name Required Type Description
Items True

RevokeInventoryItem[]

Array of player items to revoke, between 1 and 25 items.

Responses

Name Type Description
200 OK

RevokeInventoryItemsResult

400 Bad Request

ApiErrorWrapper

This is the outer wrapper for all responses with errors

Security

X-SecretKey

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

Type: apiKey
In: header

Definitions

Name Description
ApiErrorWrapper

The basic wrapper around every failed API response
GenericErrorCodes
RevokeInventoryItem
RevokeInventoryItemsRequest

In cases where the inventory item in question is a "crate", and the items it contained have already been dispensed, this will not revoke access or otherwise remove the items which were dispensed.
RevokeInventoryItemsResult
RevokeItemError

ApiErrorWrapper

The basic wrapper around every failed API response

Name Type Description
code

integer

Numerical HTTP code
error

string

Playfab error code
errorCode

integer

Numerical PlayFab error code
errorDetails

object

Detailed description of individual issues with the request object
errorMessage

string

Description for the PlayFab errorCode
status

string

String HTTP code

GenericErrorCodes

Name Type Description
APIClientRequestRateLimitExceeded

string

APIConcurrentRequestLimitExceeded

string

APINotEnabledForGameClientAccess

string

APINotEnabledForGameServerAccess

string

APINotIncludedInTitleUsageTier

string

APIRequestLimitExceeded

string

APIRequestsDisabledForTitle

string

AccountAlreadyLinked

string

AccountBanned

string

AccountDeleted

string

AccountNotFound

string

AccountNotLinked

string

ActionGroupNotFound

string

AddonAlreadyExists

string

AddonDoesntExist

string

AggregationTypeNotAllowedForMultiColumnStatistic

string

AllAdPlacementViewsAlreadyConsumed

string

AllowNonUniquePlayerDisplayNamesDisableNotAllowed

string

AmazonValidationError

string

AnalysisSubscriptionFailed

string

AnalysisSubscriptionFoundAlready

string

AnalysisSubscriptionManagementInvalidInput

string

AnalysisSubscriptionNotFound

string

AnalyticsSegmentCountOverLimit

string

ApiDisabledForMigration

string

ApiNotEnabledForTitle

string

ApiNotIncludedInAzurePlayFabFeatureSet

string

AppleNotEnabledForTitle

string

AsyncExportNotFound

string

AsyncExportNotInFlight

string

AsyncExportRateLimitExceeded

string

AuthTokenAlreadyUsedToResetPassword

string

AuthTokenDoesNotExist

string

AuthTokenExpired

string

AutomationInvalidInput

string

AutomationInvalidRuleName

string

AutomationRuleAlreadyExists

string

AutomationRuleLimitExceeded

string

AutomationRuleNotFound

string

AzureResourceConcurrentOperationInProgress

string

AzureResourceManagerNotSupportedInStamp

string

AzureTitleCreationInProgress

string

BadPartnerConfiguration

string

BillingInformationRequired

string

BodyTooLarge

string

BuildAlreadyExists

string

BuildNotAvailable

string

BuildNotFound

string

BuildPackageDoesNotExist

string

CannotEnableMultiplayerServersForTitle

string

CannotEnablePartiesForTitle

string

CatalogApiNotImplemented

string

CatalogBadRequest

string

CatalogClientIdentityInvalid

string

CatalogConfigInvalid

string

CatalogEntityInvalid

string

CatalogFeatureDisabled

string

CatalogItemIdInvalid

string

CatalogItemMetadataInvalid

string

CatalogItemTypeInvalid

string

CatalogNotConfigured

string

CatalogOneOrMoreFilesInvalid

string

CatalogPlayerIdMissing

string

CatalogSearchParameterInvalid

string

CatalogTitleIdMissing

string

CatalogTooManyRequests

string

CharacterNotFound

string

CloudScriptAPIRequestCountExceeded

string

CloudScriptAPIRequestError

string

CloudScriptAzureFunctionsArgumentSizeExceeded

string

CloudScriptAzureFunctionsEventHubRequestError

string

CloudScriptAzureFunctionsExecutionTimeLimitExceeded

string

CloudScriptAzureFunctionsHTTPRequestError

string

CloudScriptAzureFunctionsQueueRequestError

string

CloudScriptAzureFunctionsReturnSizeExceeded

string

CloudScriptExecutionTimeLimitExceeded

string

CloudScriptFunctionArgumentSizeExceeded

string

CloudScriptFunctionNameSizeExceeded

string

CloudScriptHTTPRequestError

string

CloudScriptNotFound

string

CloudScriptUnableToDeleteProductionRevision

string

ConcurrentEditError

string

ContainerKeyInvalid

string

ContainerNotOwned

string

ContentNotFound

string

ContentQuotaExceeded

string

ContentS3OriginBucketNotConfigured

string

CopilotDisabled

string

CopilotInvalidRequest

string

CouponAlreadyRedeemed

string

CouponCodeNotFound

string

CreateSegmentRateLimitExceeded

string

CustomAnalyticsEventsNotEnabledForTitle

string

CustomIdNotFound

string

CustomIdNotLinked

string

DAULimitExceeded

string

DataIntegrityError

string

DataLengthExceeded

string

DataUpdateRateExceeded

string

DatabaseThroughputExceeded

string

DeleteKeyConflict

string

DeleteSegmentRateLimitExceeded

string

DeviceAlreadyLinked

string

DeviceNotLinked

string

DownstreamServiceUnavailable

string

DuplicateColumnNameFound

string

DuplicateDropTableId

string

DuplicateEmail

string

DuplicateKeys

string

DuplicateLinkedStatisticColumnNameFound

string

DuplicatePurchaseTransactionId

string

DuplicateRoleId

string

DuplicateStatisticName

string

DuplicateStudioName

string

DuplicateTitleName

string

DuplicateTitleNameForPublisher

string

DuplicateUsername

string

EconomyServiceInternalError

string

EconomyServiceUnavailable

string

ElasticSearchOperationFailed

string

EmailAddressNotAvailable

string

EmailClientCanceledTask

string

EmailClientTimeout

string

EmailConfirmationTokenDoesNotExist

string

EmailConfirmationTokenExpired

string

EmailMessageFromAddressIsMissing

string

EmailMessageToAddressIsMissing

string

EmailRecipientBlacklisted

string

EmailReportAlreadySent

string

EmailReportRecipientBlacklisted

string

EmailTemplateInvalidSyntax

string

EmailTemplateMissing

string

EmailTemplateMissingCallback

string

EmailTemplateMissingDefaultVersion

string

EncryptedRequestNotAllowed

string

EncryptionKeyBroken

string

EncryptionKeyDisabled

string

EncryptionKeyMissing

string

EntityAPIKeyCreationDisabledForEntity

string

EntityAPIKeyLimitExceeded

string

EntityAPIKeyNotFound

string

EntityAPIKeyOrSecretInvalid

string

EntityAPIKeysNotSupported

string

EntityBlockedByGroup

string

EntityFileOperationPending

string

EntityIsAlreadyMember

string

EntityLineageBanned

string

EntityProfileConstraintValidationFailed

string

EntityProfileVersionMismatch

string

EntityTokenExpired

string

EntityTokenInvalid

string

EntityTokenMissing

string

EntityTokenRevoked

string

EntityTypeMismatchWithStatDefinition

string

ErrorCreatingStream

string

EvaluationModePlayerCountExceeded

string

EvaluationModeTitleCountExceeded

string

EventEntityNotAllowed

string

EventNamespaceNotAllowed

string

EventNotFound

string

EventSamplingInvalidEventName

string

EventSamplingInvalidEventNamespace

string

EventSamplingInvalidRatio

string

EventSamplingRatioNotFound

string

EventSinkAadNotFound

string

EventSinkConnectionInvalid

string

EventSinkConnectionUnauthorized

string

EventSinkContainerNotFound

string

EventSinkDatabaseNotFound

string

EventSinkInsufficientRoleAssignment

string

EventSinkLimitExceeded

string

EventSinkNameInvalid

string

EventSinkNotFound

string

EventSinkRegionInvalid

string

EventSinkSasTokenInvalid

string

EventSinkSasTokenPermissionInvalid

string

EventSinkSecretInvalid

string

EventSinkTenantIdInvalid

string

EventSinkTenantNotFound

string

EventSinkTitleUnauthorized

string

ExperimentInvalidId

string

ExperimentationClientTimeout

string

ExperimentationExclusionGroupCannotDelete

string

ExperimentationExclusionGroupInsufficientCapacity

string

ExperimentationExclusionGroupInvalidName

string

ExperimentationExclusionGroupInvalidTrafficAllocation

string

ExperimentationExclusionGroupNotFound

string

ExperimentationExperimentDeleted

string

ExperimentationExperimentNeverStarted

string

ExperimentationExperimentNotFound

string

ExperimentationExperimentRunning

string

ExperimentationExperimentSchedulingInProgress

string

ExperimentationExperimentStopped

string

ExperimentationInvalidDuration

string

ExperimentationInvalidEndDate

string

ExperimentationInvalidStartDate

string

ExperimentationInvalidVariableConfiguration

string

ExperimentationInvalidVariantConfiguration

string

ExperimentationMaxDurationExceeded

string

ExperimentationMaxExperimentsReached

string

ExperimentationNoScorecard

string

ExperimentationTreatmentAssignmentDisabled

string

ExperimentationTreatmentAssignmentFailed

string

ExpiredAuthToken

string

ExpiredContinuationToken

string

ExpiredGameTicket

string

ExpiredXboxLiveToken

string

ExplicitContentDetected

string

ExplorerBasicCreateQueryError

string

ExplorerBasicDeleteQueryError

string

ExplorerBasicInvalidQueryAggregateProperty

string

ExplorerBasicInvalidQueryAggregateType

string

ExplorerBasicInvalidQueryConditions

string

ExplorerBasicInvalidQueryDescription

string

ExplorerBasicInvalidQueryEndDate

string

ExplorerBasicInvalidQueryGroupBy

string

ExplorerBasicInvalidQueryName

string

ExplorerBasicInvalidQueryStartDate

string

ExplorerBasicLoadQueriesError

string

ExplorerBasicLoadQueryError

string

ExplorerBasicSavedQueriesLimit

string

ExplorerBasicSavedQueryNotFound

string

ExplorerBasicUpdateQueryError

string

ExportAmazonBucketDoesNotExist

string

ExportBlobContainerDoesNotExist

string

ExportCannotDetermineEventQuery

string

ExportCannotParseQuery

string

ExportCantEditPendingExport

string

ExportControlCommandsNotAllowed

string

ExportCouldNotCreate

string

ExportCouldNotDelete

string

ExportCouldNotUpdate

string

ExportInsightsV1Deprecated

string

ExportInvalidBlobStorage

string

ExportInvalidPartitionStatusModification

string

ExportInvalidPrefix

string

ExportInvalidQuerySchemaModification

string

ExportInvalidStatusUpdate

string

ExportInvalidStorageType

string

ExportKustoConnectionFailed

string

ExportKustoException

string

ExportLimitEvents

string

ExportLimitExports

string

ExportNoBackingDatabaseFound

string

ExportNotFound

string

ExportQueryMissingTableReference

string

ExportQuerySchemaMissingRequiredColumns

string

ExportUnknownError

string

ExpressionInvokeFailure

string

ExpressionParseFailure

string

ExpressionTooLong

string

ExternalEntityNotAllowedForTier

string

FacebookAPIError

string

FacebookInstantGamesAuthNotConfiguredForTitle

string

FacebookInstantGamesIdNotLinked

string

FailedByPaymentProvider

string

FailedLoginAttemptRateLimitExceeded

string

FailedToConsumeEntitlement

string

FailedToGetEntitlements

string

FeatureNotConfiguredForTitle

string

FileNotFound

string

FileTooLarge

string

ForbiddenByEntityPolicy

string

FreeTierCannotHaveVirtualCurrency

string

GameCenterAuthenticationFailed

string

GameModeNotFound

string

GameNotFound

string

GameSaveBadRequest

string

GameSaveConflictUpdatingManifest

string

GameSaveDataStorageQuotaExceeded

string

GameSaveFileAlreadyExists

string

GameSaveFileExceededReportedSize

string

GameSaveFileNotUploaded

string

GameSaveManifestNotFound

string

GameSaveManifestUpdatesNotAllowed

string

GameSaveManifestVersionAlreadyExists

string

GameSaveManifestVersionNotFinalized

string

GameSaveNewerManifestExists

string

GameSaveOperationNotAllowed

string

GameSaveUnknownFileInManifest

string

GameServerBuildCountLimitExceeded

string

GameServerBuildSizeLimitExceeded

string

GameServerHostCountLimitExceeded

string

GameTicketDoesNotMatchLobby

string

GetPlayersInSegmentRateLimitExceeded

string

GetSegmentsRateLimitExceeded

string

GoogleAPIServiceUnavailable

string

GoogleAPIServiceUnknownError

string

GoogleOAuthError

string

GoogleOAuthNoIdTokenIncludedInResponse

string

GoogleOAuthNotConfiguredForTitle

string

GoogleServiceAccountFailedAuth

string

GoogleServiceAccountInvalid

string

GoogleServiceAccountParseFailure

string

GroupApplicationNotFound

string

GroupInvitationNotFound

string

GroupNameNotAvailable

string

GuildNotFound

string

IdentifierAlreadyClaimed

string

IdentifierNotLinked

string

InsightsManagementDatabaseNotFound

string

InsightsManagementErrorPendingOperationExists

string

InsightsManagementGetOperationStatusInvalidParameter

string

InsightsManagementGetStorageUsageInvalidParameter

string

InsightsManagementNewActiveEventExportLimitInvalid

string

InsightsManagementOperationNotFound

string

InsightsManagementSetPerformanceLevelInvalidParameter

string

InsightsManagementSetPerformanceRateLimited

string

InsightsManagementSetStorageRetentionAboveMaximum

string

InsightsManagementSetStorageRetentionBelowMinimum

string

InsightsManagementSetStorageRetentionInvalidParameter

string

InsightsManagementTitleNotInFlight

string

InsightsV1Deprecated

string

InsufficientFunds

string

InsufficientGuildRole

string

InternalServerError

string

InvalidAPIEndpoint

string

InvalidAccount

string

InvalidAdPlacementAndReward

string

InvalidAttributeStatisticsSpecified

string

InvalidAuthToken

string

InvalidBaseTimeForInterval

string

InvalidBundleID

string

InvalidBuyerInfo

string

InvalidCatalogItemConfiguration

string

InvalidCertificateForAad

string

InvalidCharacterStatistics

string

InvalidContainerItem

string

InvalidContentType

string

InvalidContinuationToken

string

InvalidCurrencyCode

string

InvalidDeveloper

string

InvalidDeviceID

string

InvalidDisplayNameRandomSuffixLength

string

InvalidDropTable

string

InvalidEmailAddress

string

InvalidEmailOrPassword

string

InvalidEntityId

string

InvalidEntityType

string

InvalidEnvironmentForReceipt

string

InvalidEventContents

string

InvalidEventField

string

InvalidEventName

string

InvalidExternalEntityId

string

InvalidFacebookInstantGamesSignature

string

InvalidFacebookToken

string

InvalidGameCenterAuthRequest

string

InvalidGameCenterId

string

InvalidGameTicket

string

InvalidGooglePlayGamesServerAuthCode

string

InvalidGoogleToken

string

InvalidHostForTitleId

string

InvalidIdentityProviderId

string

InvalidItemId

string

InvalidItemIdInTable

string

InvalidItemProperties

string

InvalidJSONContent

string

InvalidKongregateToken

string

InvalidLocalizedPushNotificationLanguage

string

InvalidNamespaceMismatch

string

InvalidNintendoSwitchAccountId

string

InvalidOrderInfo

string

InvalidPSNAuthCode

string

InvalidPSNIssuerId

string

InvalidParams

string

InvalidPartnerResponse

string

InvalidPassword

string

InvalidPaymentProvider

string

InvalidPlatform

string

InvalidPlayerAccountPoolId

string

InvalidProductForSubscription

string

InvalidPublicKey

string

InvalidPublisherId

string

InvalidPurchaseTransactionStatus

string

InvalidPushNotificationToken

string

InvalidReceipt

string

InvalidRegion

string

InvalidReportDate

string

InvalidRequest

string

InvalidScheduledTaskName

string

InvalidScheduledTaskParameter

string

InvalidScheduledTaskType

string

InvalidSearchTerm

string

InvalidSegment

string

InvalidServiceConfiguration

string

InvalidServiceLimitLevel

string

InvalidSessionId

string

InvalidSessionTicket

string

InvalidSharedGroupId

string

InvalidSharedSecretKey

string

InvalidSignature

string

InvalidSignatureTime

string

InvalidStatistic

string

InvalidStatisticName

string

InvalidStatisticScore

string

InvalidSteamTicket

string

InvalidTaskSchedule

string

InvalidTicket

string

InvalidTitleForDeveloper

string

InvalidTitleId

string

InvalidTokenResultFromAad

string

InvalidTwitchToken

string

InvalidTypeInBody

string

InvalidUserStatistics

string

InvalidUsername

string

InvalidUsernameOrPassword

string

InvalidVirtualCurrency

string

InvalidVirtualCurrencyCode

string

InvalidXboxLiveToken

string

InventoryApiNotImplemented

string

IpAddressBanned

string

ItemNotAffordable

string

ItemNotFound

string

ItemNotOwned

string

ItemNotRecycleable

string

JavascriptException

string

KeyLengthExceeded

string

KeyNotOwned

string

LeaderboardColumnLengthMismatch

string

LeaderboardColumnLengthMismatchWithStatDefinition

string

LeaderboardColumnsNotSpecified

string

LeaderboardCountLimitExceeded

string

LeaderboardDefinitionModificationNotAllowedWhileLinked

string

LeaderboardMaxSizeTooLarge

string

LeaderboardNameConflict

string

LeaderboardNotFound

string

LeaderboardSizeLimitExceeded

string

LeaderboardUpdateNotAllowedWhileLinked

string

LeaderboardVersionNotAvailable

string

LegacyMultiplayerServersDeprecated

string

LimitNotAnUpgradeOption

string

LimitNotAvailableViaAPI

string

LimitNotFound

string

LimitedEditionItemUnavailable

string

LinkedAccountAlreadyClaimed

string

LinkedDeviceAlreadyClaimed

string

LinkedIdentifierAlreadyClaimed

string

LinkedStatisticColumnMismatch

string

LinkedStatisticColumnNotFound

string

LinkedStatisticColumnRequired

string

LinkingStatsNotAllowedForEntityType

string

LobbyBadRequest

string

LobbyCurrentOwnerStillConnected

string

LobbyCurrentPlayersMoreThanMaxPlayers

string

LobbyDifferentServerAlreadyJoined

string

LobbyDoesNotExist

string

LobbyDoesNotUseConnections

string

LobbyIsNotClientOwned

string

LobbyMemberCannotRejoin

string

LobbyMemberIsNotOwner

string

LobbyNewOwnerMustBeConnected

string

LobbyNotJoinable

string

LobbyPlayerAlreadyJoined

string

LobbyPlayerMaxLobbyLimitExceeded

string

LobbyPlayerNotPresent

string

LobbyRateLimitExceeded

string

LobbyServerAlreadyJoined

string

LobbyServerMismatch

string

LobbyServerNotFound

string

ManageEventNameInvalid

string

ManageEventNamespaceInvalid

string

ManageEventsInvalidRatio

string

ManagedEventInvalid

string

ManagedEventNotFound

string

MatchmakingAlreadyJoinedTicket

string

MatchmakingAttributeInvalid

string

MatchmakingBadRequest

string

MatchmakingEntityInvalid

string

MatchmakingMatchNotFound

string

MatchmakingMemberProfileInvalid

string

MatchmakingNotEnabled

string

MatchmakingNumberOfPlayersInTicketTooLarge

string

MatchmakingPlayerAttributesInvalid

string

MatchmakingPlayerAttributesTooLarge

string

MatchmakingPlayerHasNotJoinedTicket

string

MatchmakingQueueConfigInvalid

string

MatchmakingQueueLimitExceeded

string

MatchmakingQueueNotFound

string

MatchmakingRateLimitExceeded

string

MatchmakingRequestTypeMismatch

string

MatchmakingTicketAlreadyCompleted

string

MatchmakingTicketMembershipLimitExceeded

string

MatchmakingTicketNotFound

string

MatchmakingUnauthorized

string

MaxActionDepthExceeded

string

MaxQueryableVersionsValueNotAllowedForTier

string

MaximumSegmentBulkActionJobsRunning

string

MembershipDefinitionInUse

string

MembershipNameTooLong

string

MembershipNotFound

string

MisconfiguredIdentityProvider

string

MissingAmazonSharedKey

string

MissingLocalizedPushNotificationMessage

string

MissingTitleGoogleProperties

string

MultiplayerServerBadRequest

string

MultiplayerServerBuildAliasReferencedByMatchmakingQueue

string

MultiplayerServerBuildReferencedByBuildAlias

string

MultiplayerServerBuildReferencedByMatchmakingQueue

string

MultiplayerServerConflict

string

MultiplayerServerError

string

MultiplayerServerForbidden

string

MultiplayerServerInternalServerError

string

MultiplayerServerNoContent

string

MultiplayerServerNotFound

string

MultiplayerServerTitleQuotaCoresExceeded

string

MultiplayerServerTooManyRequests

string

MultiplayerServerUnauthorized

string

MultiplayerServerUnavailable

string

MultipleLinkedStatisticsNotAllowed

string

NameNotAvailable

string

NamespaceMismatch

string

NintendoSwitchDeviceIdNotLinked

string

NintendoSwitchNotEnabledForTitle

string

NoActionsOnPlayersInSegmentJob

string

NoContactEmailAddressFound

string

NoEntityFileOperationPending

string

NoGameModeParamsSet

string

NoLeaderboardForStatistic

string

NoLinkedStatisticToLeaderboard

string

NoMatchingCatalogItemForReceipt

string

NoPartnerEnabled

string

NoPushNotificationARNForTitle

string

NoRealMoneyPriceForCatalogItem

string

NoRemainingUses

string

NoSecretKeyEnabledForCloudScript

string

NoSharedSecretKeyConfigured

string

NoSuchMod

string

NoValidCertificateForAad

string

NoValidIdentityForAad

string

NoWritePermissionsForEvent

string

NonPositiveValue

string

NotAuthenticated

string

NotAuthorized

string

NotAuthorizedByTitle

string

NotImplemented

string

NullTokenResultFromAad

string

OperationCanceled

string

OperationNotSupportedForPlatform

string

OutstandingApplicationAcceptedInstead

string

OutstandingInvitationAcceptedInstead

string

OverLimit

string

PIIContentDetected

string

PSNInaccessible

string

PaidInsightsFeaturesNotEnabled

string

PartialFailure

string

PartitionedEventCountOverLimit

string

PartitionedEventInvalid

string

PartyBadRequest

string

PartyConflict

string

PartyError

string

PartyForbidden

string

PartyInternalServerError

string

PartyNoContent

string

PartyNotFound

string

PartyRequests

string

PartyRequestsThrottledFromRateLimiter

string

PartySerializationError

string

PartyTooManyRequests

string

PartyUnauthorized

string

PartyUnavailable

string

PartyVersionNotFound

string

PaymentPageNotConfigured

string

PerEntityEventRateLimitExceeded

string

PhotonApplicationIdAlreadyInUse

string

PhotonApplicationNotAssociatedWithTitle

string

PhotonApplicationNotFound

string

PhotonNotEnabledForTitle

string

PlayStreamConnectionFailed

string

PlayerAccountPoolDeleted

string

PlayerAccountPoolNotFound

string

PlayerCustomPropertiesDuplicatePropertyName

string

PlayerCustomPropertiesPropertyCountTooHigh

string

PlayerCustomPropertiesPropertyDoesNotExist

string

PlayerCustomPropertiesPropertyNameIsInvalid

string

PlayerCustomPropertiesPropertyNameTooLong

string

PlayerCustomPropertiesStringPropertyValueTooLong

string

PlayerCustomPropertiesValueIsInvalidType

string

PlayerCustomPropertiesVersionMismatch

string

PlayerIdentityLinkNotFound

string

PlayerNotInGame

string

PlayerSecretAlreadyConfigured

string

PlayerSecretNotConfigured

string

PlayerTagCountLimitExceeded

string

PrizeTableHasMissingRanks

string

PrizeTableHasNoRanks

string

PrizeTableHasOverlappingRanks

string

PrizeTableRankStartsAtZero

string

ProfaneDisplayName

string

ProfileDoesNotExist

string

PubSubConnectionHandleInvalid

string

PubSubConnectionNotFoundForEntity

string

PubSubFeatureNotEnabledForTitle

string

PubSubSubscriptionLimitExceeded

string

PubSubTooManyRequests

string

PublisherDeleted

string

PublisherNotFound

string

PublisherNotSet

string

PurchaseDoesNotExist

string

PurchaseInitializationFailure

string

PushNotEnabledForAccount

string

PushNotificationTemplateAndroidPayloadMissingNotificationBody

string

PushNotificationTemplateContainsInvalidAndroidPayload

string

PushNotificationTemplateContainsInvalidIosPayload

string

PushNotificationTemplateInvalidPayload

string

PushNotificationTemplateInvalidSyntax

string

PushNotificationTemplateIosPayloadMissingNotificationBody

string

PushNotificationTemplateMissingDefaultVersion

string

PushNotificationTemplateMissingName

string

PushNotificationTemplateMissingPlatformPayload

string

PushNotificationTemplateNoCustomPayloadForV1

string

PushNotificationTemplateNotFound

string

PushNotificationTemplatePayloadContainsInvalidJson

string

PushServiceError

string

QueryRateLimitExceeded

string

ReceiptAlreadyUsed

string

ReceiptCancelled

string

ReceiptContainsMultipleInAppItems

string

ReceiptDoesNotContainInAppItems

string

RegionAtCapacity

string

RegistrationIncomplete

string

RegistrationSessionNotFound

string

ReportDataNotRetrievedSuccessfully

string

ReportNotAvailable

string

RequestAlreadyRunning

string

RequestMultiplayerServersThrottledFromRateLimiter

string

RequestViewConstraintParamsNotAllowed

string

ReservedEventName

string

ReservedWordInBody

string

ResettableStatisticVersionRequired

string

ResourceNameUpdateNotAllowed

string

RestrictedEmailDomain

string

RevisionNotFound

string

RoleDoesNotExist

string

RoleIsGroupAdmin

string

RoleIsGroupDefaultMember

string

RoleNameNotAvailable

string

ScheduledTaskCreateConflict

string

ScheduledTaskNameConflict

string

SecretKeyNotFound

string

SegmentManagementInvalidInput

string

SegmentManagementInvalidSegmentId

string

SegmentManagementInvalidSegmentName

string

SegmentManagementNoExpressionTree

string

SegmentManagementSegmentCountOverLimit

string

SegmentManagementTitleNotInFlight

string

SegmentManagementTriggerActionCountOverLimit

string

SegmentNotFound

string

ServerFailedToStart

string

ServiceLimitLevelInTransition

string

ServiceUnavailable

string

SessionLogNotFound

string

SignedRequestNotAllowed

string

SmtpAddonNotEnabled

string

SmtpServerAuthenticationError

string

SmtpServerCommunicationError

string

SmtpServerGeneralFailure

string

SmtpServerInsufficientStorage

string

SmtpServerLimitExceeded

string

SnapshotNotFound

string

SpecifiedVersionLeaderboardNotFound

string

StatDefinitionAlreadyLinkedToLeaderboard

string

StateShareCreatedStatesLimitExceeded

string

StateShareForbidden

string

StateShareIdMissingOrMalformed

string

StateShareLinkNotFound

string

StateShareStateNotFound

string

StateShareStateRedemptionLimitExceeded

string

StateShareStateRedemptionLimitNotUpdated

string

StateShareTitleNotInFlight

string

StatisticAlreadyHasPrizeTable

string

StatisticChildNameInvalid

string

StatisticColumnLengthMismatch

string

StatisticCountLimitExceeded

string

StatisticDefinitionHasNullOrEmptyVersionConfiguration

string

StatisticDefinitionModificationNotAllowedWhileLinked

string

StatisticNameConflict

string

StatisticNotFound

string

StatisticUpdateInProgress

string

StatisticValueAggregationOverflow

string

StatisticVersionAlreadyIncrementedForScheduledInterval

string

StatisticVersionClosedForWrites

string

StatisticVersionIncrementRateExceeded

string

StatisticVersionInvalid

string

SteamApplicationNotOwned

string

SteamNotEnabledForTitle

string

SteamUserNotFound

string

StoreNotFound

string

StreamAlreadyExists

string

StreamNotFound

string

StudioActivated

string

StudioCreationInProgress

string

StudioCreationRateLimited

string

StudioDeactivated

string

StudioDeleted

string

StudioNotFound

string

SubscriptionAlreadyTaken

string

Success

string

TaskInstanceNotFound

string

TaskNotFound

string

TelemetryIngestionKeyNotFound

string

TelemetryIngestionKeyPending

string

TelemetryKeyAlreadyExists

string

TelemetryKeyCountOverLimit

string

TelemetryKeyDeactivated

string

TelemetryKeyInvalid

string

TelemetryKeyInvalidName

string

TelemetryKeyLongInsightsRetentionNotAllowed

string

TelemetryKeyNotFound

string

TemplateVersionNotDefined

string

TemplateVersionTooOld

string

TenantShardMapperShardNotFound

string

TitleActivated

string

TitleActivationInProgress

string

TitleActivationRateLimited

string

TitleCleanupInProgress

string

TitleConfigNotFound

string

TitleConfigSerializationError

string

TitleConfigUpdateConflict

string

TitleConstraintsPublisherDeletion

string

TitleContainsUserAccounts

string

TitleCreationInProgress

string

TitleCreationRateLimited

string

TitleDataOverrideNotFound

string

TitleDeactivated

string

TitleDefaultLanguageNotSet

string

TitleDeleted

string

TitleDeletionPlayerCleanupFailure

string

TitleNameConflicts

string

TitleNewsDuplicateLanguage

string

TitleNewsInvalidLanguage

string

TitleNewsItemCountLimitExceeded

string

TitleNewsMissingDefaultLanguage

string

TitleNewsMissingTitleOrBody

string

TitleNewsNotFound

string

TitleNotActivated

string

TitleNotEnabledForParty

string

TitleNotOnUpdatedPricingPlan

string

TitleNotQualifiedForLimit

string

TitlePublisherUpdateNotAllowed

string

TokenSigningKeyNotFound

string

TooManyKeys

string

TotalDataSizeExceeded

string

TradeAcceptedCatalogItemInvalid

string

TradeAcceptedCatalogItemIsNotTradable

string

TradeAcceptedItemIsBundle

string

TradeAcceptedItemIsStackable

string

TradeAcceptedItemsMismatch

string

TradeAcceptingUserNotAllowed

string

TradeAllowedUsersInvalid

string

TradeAlreadyFilled

string

TradeCancelled

string

TradeDoesNotExist

string

TradeInventoryItemDoesNotExist

string

TradeInventoryItemExpired

string

TradeInventoryItemInvalidStatus

string

TradeInventoryItemIsAssignedToCharacter

string

TradeInventoryItemIsBundle

string

TradeInventoryItemIsConsumed

string

TradeInventoryItemIsNotTradable

string

TradeInventoryItemIsStackable

string

TradeMissingOfferedAndAcceptedItems

string

TradeStatusNotValidForAccepting

string

TradeStatusNotValidForCancelling

string

TradeWaitForStatusTimeout

string

TransactionAlreadyApplied

string

TrueSkillActiveModelLimitExceeded

string

TrueSkillBadPlayerIdInMatchResult

string

TrueSkillConditionKeyLimitExceeded

string

TrueSkillConditionSetNotInModel

string

TrueSkillConditionStateIsRequired

string

TrueSkillConditionValuePerKeyLimitExceeded

string

TrueSkillDuplicateCondition

string

TrueSkillDuplicateEvent

string

TrueSkillDuplicatePlayerInMatchResult

string

TrueSkillEndTimeBeforeStartTime

string

TrueSkillEndTimeMissingInMatchResult

string

TrueSkillEventLimitExceeded

string

TrueSkillEventStateIsRequired

string

TrueSkillInvalidAnomalyThreshold

string

TrueSkillInvalidBotIdInMatchResult

string

TrueSkillInvalidConditionAffinityWeight

string

TrueSkillInvalidConditionKey

string

TrueSkillInvalidConditionValue

string

TrueSkillInvalidEntityKey

string

TrueSkillInvalidEventCount

string

TrueSkillInvalidEventName

string

TrueSkillInvalidJobId

string

TrueSkillInvalidMaxIterations

string

TrueSkillInvalidMetadataId

string

TrueSkillInvalidModelId

string

TrueSkillInvalidModelName

string

TrueSkillInvalidPlayerId

string

TrueSkillInvalidPlayerIds

string

TrueSkillInvalidPlayerSecondsPlayedInMatchResult

string

TrueSkillInvalidPlayers

string

TrueSkillInvalidPreMatchPartyInMatchResult

string

TrueSkillInvalidRanksInMatchResult

string

TrueSkillInvalidScenarioId

string

TrueSkillInvalidScenarioName

string

TrueSkillInvalidSquadSize

string

TrueSkillInvalidTimestamp

string

TrueSkillInvalidTimestampInMatchResult

string

TrueSkillInvalidTitleId

string

TrueSkillJobAlreadyExists

string

TrueSkillJobNotFound

string

TrueSkillMatchResultAlreadySubmitted

string

TrueSkillMatchResultCreated

string

TrueSkillMissingBuildVerison

string

TrueSkillMissingRequiredCondition

string

TrueSkillMissingRequiredEvent

string

TrueSkillModelIsNotActive

string

TrueSkillModelStateInvalidForOperation

string

TrueSkillNoModelInScenario

string

TrueSkillNoPlayerInMatchResultTeam

string

TrueSkillNoTeamInMatchResult

string

TrueSkillNoWinnerInMatchResult

string

TrueSkillNotEnoughTeamsInMatchResult

string

TrueSkillNotSupportedForTitle

string

TrueSkillOperationCanceled

string

TrueSkillPlayersInMatchResultExceedingLimit

string

TrueSkillScenarioConfigDoesNotExist

string

TrueSkillScenarioContainsActiveModel

string

TrueSkillStartTimeMissingInMatchResult

string

TrueSkillTotalModelLimitExceeded

string

TrueSkillTrueSkillPlayerNull

string

TrueSkillUnauthorized

string

TrueSkillUnauthorizedForJob

string

TrueSkillUnauthorizedToQueryOtherPlayerSkills

string

TrueSkillUnknownConditionKey

string

TrueSkillUnknownConditionValue

string

TrueSkillUnknownEventName

string

TrueSkillUnknownInitialModelId

string

TrueSkillUnknownModelId

string

TwitchResponseError

string

TwoFactorAuthenticationTokenRequired

string

UnableToConnectToDatabase

string

UnknownError

string

UnkownError

string

UpdateInventoryRateLimitExceeded

string

UpdateSegmentRateLimitExceeded

string

UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier

string

UserAlreadyAdded

string

UserIsNotPartOfDeveloper

string

UserNotFriend

string

UserisNotValid

string

UsernameNotAvailable

string

UsersAlreadyFriends

string

ValueAlreadyExists

string

VariableNotDefined

string

VersionNotFound

string

VirtualCurrencyBetaCreateError

string

VirtualCurrencyBetaDeleteError

string

VirtualCurrencyBetaGetError

string

VirtualCurrencyBetaInitialDepositSaveError

string

VirtualCurrencyBetaRestoreError

string

VirtualCurrencyBetaSaveConflict

string

VirtualCurrencyBetaSaveError

string

VirtualCurrencyBetaUpdateError

string

VirtualCurrencyCannotBeDeleted

string

VirtualCurrencyCannotBeSetToOlderVersion

string

VirtualCurrencyCodeExists

string

VirtualCurrencyCountLimitExceeded

string

VirtualCurrencyCurrentlyUnavailable

string

VirtualCurrencyMustBeWithinIntegerRange

string

WasNotCreatedWithCloudRoot

string

WriteAttemptedDuringExport

string

WrongPrice

string

WrongSteamAccount

string

WrongVirtualCurrency

string

XboxBPCertificateFailure

string

XboxInaccessible

string

XboxRejectedXSTSExchangeRequest

string

XboxServiceTooManyRequests

string

XboxXASSExchangeFailure

string

RevokeInventoryItem

Name Type Description
CharacterId

string

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

string

Unique PlayFab assigned instance identifier of the item
PlayFabId

string

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

RevokeInventoryItemsRequest

In cases where the inventory item in question is a "crate", and the items it contained have already been dispensed, this will not revoke access or otherwise remove the items which were dispensed.

Name Type Description
Items

RevokeInventoryItem[]

Array of player items to revoke, between 1 and 25 items.

RevokeInventoryItemsResult

Name Type Description
Errors

RevokeItemError[]

Collection of any errors that occurred during processing.

RevokeItemError

Name Type Description
Error

GenericErrorCodes

Specific error that was encountered.
Item

RevokeInventoryItem

Item information that failed to be revoked.

Error Codes

Name Code
ItemNotFound 1047