Skip to main content
POST
Delete Player Custom Properties

Authorizations

X-Authorization
string
header
required

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

Body

application/json

Deletes custom properties for the specified player. The list of provided property names must be non-empty.

Deletes custom properties for the specified player. The list of provided property names must be non-empty.

PropertyNames
string[]
required

A list of property names denoting which properties should be deleted.

CustomTags
object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

ExpectedPropertiesVersion
number

Optional field used for concurrency control. One can ensure that the delete operation will only be performed if the player's properties have not been updated by any other clients since the last version.

Response

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
Example:
Last modified on October 1, 2026