Catalog - Set Item Moderation State

Service:

Economy

API Version:

240514

Sets the moderation state for an item, including the concern category and string reason. More information about moderation states can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/ugc/moderation

POST https://titleId.playfabapi.com/Catalog/SetItemModerationState

Request Header

Name	Required	Type	Description
X-EntityToken	True	string	This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Request Body

Name	Type	Description
AlternateId	CatalogAlternateId	An alternate ID associated with this item.
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Id	string	The unique ID of the item.
Reason	string	The reason for the moderation state change for the associated item.
Status	ModerationStatus	The status to set for the associated item.

Responses

Name	Type	Description
200 OK	SetItemModerationStateResponse
400 Bad Request	ApiErrorWrapper	This is the outer wrapper for all responses with errors

Security

X-EntityToken

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Type: apiKey
In: header

Definitions

Name	Description
ApiErrorWrapper	The basic wrapper around every failed API response
CatalogAlternateId
ModerationStatus
SetItemModerationStateRequest
SetItemModerationStateResponse

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

CatalogAlternateId

Name	Type	Description
Type	string	Type of the alternate ID.
Value	string	Value of the alternate ID.

ModerationStatus

Name	Type	Description
Approved	string
AwaitingModeration	string
Rejected	string
Unknown	string

SetItemModerationStateRequest

Name	Type	Description
AlternateId	CatalogAlternateId	An alternate ID associated with this item.
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Id	string	The unique ID of the item.
Reason	string	The reason for the moderation state change for the associated item.
Status	ModerationStatus	The status to set for the associated item.

SetItemModerationStateResponse

Error Codes

Name	Code
DatabaseThroughputExceeded	1113
ItemNotFound	1047