DELETE Player

Overview

The following table contains important information about the DELETE method in regards to deleting the player by using the public ID.

DELETE Player by PublicId
Method	GET
URL or Endpoint	/api/projects/`projectId`/players/`id`
Headers	Authorization
Parameters	projectId, id
Body	Not Applicable

The description of the URL parameters is as follows:

URL Parameter Name	Mandatory	Type	Description
`projectId`	Yes	string	Unique Id of the project.
`id`	Yes	string	Unique id of the player.

Request Body

The request does not contain a request body

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": true,
  "resultInfo": null,
  "statusCode": 200
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field Name	Type	Description
success	bool	If the response is successful it will return true. Otherwise will return false.
errors	array[]	Indicates if there was an error.
messages	array[]	Returns the response message from back-end.
result	array[Object]	Returns the response object.
resultInfo	string	Returns extra information about the result.
statusCode	integer($int32)	Returns the HTTP Status Code.

If the action is successful, the service sends back an HTTP 200 or 201 response.

For information about the errors that are common to all actions, see Common Errors: