Player Removal

From time to time a player may request that all of their data be deleted. The DELETE v2/users endpoint will remove all information Teak has about a player, while retaining anonymized usage data so that metrics such as daily active users and revenue may still be properly calculated. Data removal is complete immediately upon receiving a response from this endpoint, and cannot be undone.

Destroying

Endpoint

https://api.gocarrot.com/v2/users

Request Type

DELETE

Rate Limiting

60 requests per second

Description: The DELETE v2/users endpoint removes all information Teak has about a player while retaining anonymized usage data.

Required Parameters

game_id

Your Teak App ID

secret_key

Your Teak Server Secret

user_id

The Game Assigned Player ID of the player you are removing data for.

Success Response

Status Code

200

Response Body

JSON dictionary with 'status' and 'user_id' keys.

status

One of 'ok' or 'user_not_found'. If the status is 'ok', Teak found the player record and removed all data for the player. If the status is 'user_not_found', Teak had no existing data for the given user_id for the game.

user_id

The Game Assigned Player ID data removal was requested for.

Example

{
  "status":"ok",
  "user_id":"player42"
}

Error Responses

Not Found

Status Code

404

Response Body

JSON dictionary with 'status' and 'errors' keys. 'status' will be 'error'. 'errors' will be a dictionary containing keys indicating which resources were not found, with values being an array of human readable error messages.

Example

{"status":"error","errors":{"game_id":["Unknown app id foo"]}}

Invalid Parameter

Status Code

422

Response Body

JSON dictionary with 'status' and 'errors' keys. 'status' will be 'error'. 'errors' will be a dictionary containing keys indicating which parameters were invalid, with values being an array of human readable error messages.

Example

{"status":"error","errors":{"user_id":["must be present"]}}

Rate Limit Response

Status Code

429

Response Body

JSON dictionary with 'status' and 'errors' keys. 'status' will be 'rate_limit'. 'errors' will contain the key 'rate_limit'

Example

{"status":"rate_limit","errors":{"rate_limit":["/v2/users may only be called 60 times per second. Please wait a second and try again"]}}