Player Item Management - Report Player
Submit a report about a player (due to bad bahavior, etc.) on behalf of another player, so that customer service representatives for the title can take action concerning potentially toxic players.
POST https://titleId.playfabapi.com/Server/ReportPlayerRequest 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 |
|---|---|---|---|
| ReporteeId | True |
string |
Unique PlayFab identifier of the reported player. |
| ReporterId | True |
string |
PlayFabId of the reporting 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 |
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 |
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 |
|---|---|
|
Api |
The basic wrapper around every failed API response |
|
Report |
|
|
Report |
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 |
ReportPlayerServerRequest
| 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. |
| ReporterId |
string |
PlayFabId of the reporting player. |
ReportPlayerServerResult
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 by this reporting player. |