Catalog - Update Catalog Config

Service:

Economy

API Version:

240426

Updates the configuration for the catalog. Only Title Entities can call this API. There is a limit of 10 requests in 10 seconds for this API. More information about the Catalog Config can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/settings

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

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
Config	CatalogConfig	The updated catalog configuration.
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Responses

Name	Type	Description
200 OK	UpdateCatalogConfigResponse
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
CatalogConfig
CatalogSpecificConfig
CategoryRatingConfig
DeepLinkFormat
DisplayPropertyIndexInfo
DisplayPropertyType
EntityKey	Combined entity type and ID structure which uniquely identifies a single entity.
FileConfig
ImageConfig
ReviewConfig
UpdateCatalogConfigRequest
UpdateCatalogConfigResponse
UserGeneratedContentSpecificConfig

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

CatalogConfig

Name	Type	Description
AdminEntities	EntityKey[]	A list of player entity keys that will have admin permissions. There is a maximum of 64 entities that can be added.
Catalog	CatalogSpecificConfig	The set of configuration that only applies to catalog items.
DeepLinkFormats	DeepLinkFormat[]	A list of deep link formats. Up to 10 can be added.
DisplayPropertyIndexInfos	DisplayPropertyIndexInfo[]	A list of display properties to index. Up to 5 mappings can be added per Display Property Type. More info on display properties can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/content-types-tags-and-properties#displayproperties
File	FileConfig	The set of configuration that only applies to Files.
Image	ImageConfig	The set of configuration that only applies to Images.
IsCatalogEnabled	boolean	Flag defining whether catalog is enabled.
Platforms	string[]	A list of Platforms that can be applied to catalog items. Each platform can have a maximum character length of 40 and up to 128 platforms can be listed.
Review	ReviewConfig	The set of configuration that only applies to Ratings and Reviews.
ReviewerEntities	EntityKey[]	A set of player entity keys that are allowed to review content. There is a maximum of 128 entities that can be added.
UserGeneratedContent	UserGeneratedContentSpecificConfig	The set of configuration that only applies to user generated contents.

CatalogSpecificConfig

Name	Type	Description
ContentTypes	string[]	The set of content types that will be used for validation. Each content type can have a maximum character length of 40 and up to 128 types can be listed.
Tags	string[]	The set of tags that will be used for validation. Each tag can have a maximum character length of 32 and up to 1024 tags can be listed.

CategoryRatingConfig

Name	Type	Description
Name	string	Name of the category.

DeepLinkFormat

Name	Type	Description
Format	string	The format of the deep link to return. The format should contain '{id}' to represent where the item ID should be placed.
Platform	string	The target platform for the deep link.

DisplayPropertyIndexInfo

Name	Type	Description
Name	string	The property name in the 'DisplayProperties' property to be indexed.
Type	DisplayPropertyType	The type of the property to be indexed.

DisplayPropertyType

Name	Type	Description
None	string
QueryDateTime	string
QueryDouble	string
QueryString	string
SearchString	string

EntityKey

Combined entity type and ID structure which uniquely identifies a single entity.

Name	Type	Description
Id	string	Unique ID of the entity.
Type	string	Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types

FileConfig

Name	Type	Description
ContentTypes	string[]	The set of content types that will be used for validation. Each content type can have a maximum character length of 40 and up to 128 types can be listed.
Tags	string[]	The set of tags that will be used for validation. Each tag can have a maximum character length of 32 and up to 1024 tags can be listed.

ImageConfig

Name	Type	Description
Tags	string[]	The set of tags that will be used for validation. Each tag can have a maximum character length of 32 and up to 1024 tags can be listed.

ReviewConfig

Name	Type	Description
CategoryRatings	CategoryRatingConfig[]	A set of categories that can be applied toward ratings and reviews.

UpdateCatalogConfigRequest

Name	Type	Description
Config	CatalogConfig	The updated catalog configuration.
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

UpdateCatalogConfigResponse

UserGeneratedContentSpecificConfig

Name	Type	Description
ContentTypes	string[]	The set of content types that will be used for validation.
Tags	string[]	The set of tags that will be used for validation.

Error Codes

Name	Code
BillingInformationRequired	1266
CatalogConfigInvalid	4010
InvalidEntityType	1373