Account Management - Report Player

Service:

Client

API Version:

240412

Submit a report for another player (due to bad bahavior, etc.), so that customer service representatives for the title can take action concerning potentially toxic players.

POST https://titleId.playfabapi.com/Client/ReportPlayer

Request Header

Name	Required	Type	Description
X-Authorization	True	string	This API requires a client session ticket, available from any Client Login function.

Request Body

Name	Required	Type	Description
ReporteeId	True	string	Unique PlayFab identifier of the reported player.
Comment		string	Optional additional comment by reporting player.
CustomTags		object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Responses

Name	Type	Description
200 OK	ReportPlayerClientResult	Players are currently limited to five reports per day. Attempts by a single user account to submit reports beyond five will result in Updated being returned as false.
400 Bad Request	ApiErrorWrapper	This is the outer wrapper for all responses with errors

Security

X-Authorization

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

Type: apiKey
In: header

Definitions

Name	Description
ApiErrorWrapper	The basic wrapper around every failed API response
ReportPlayerClientRequest
ReportPlayerClientResult	Players are currently limited to five reports per day. Attempts by a single user account to submit reports beyond five will result in Updated being returned as false.

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

ReportPlayerClientRequest

Name	Type	Description
Comment	string	Optional additional comment by reporting player.
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
ReporteeId	string	Unique PlayFab identifier of the reported player.

ReportPlayerClientResult

Players are currently limited to five reports per day. Attempts by a single user account to submit reports beyond five will result in Updated being returned as false.

Name	Type	Description
SubmissionsRemaining	number	The number of remaining reports which may be filed today.