Deletion Targeted User Registration API¶

The Deletion Targeted User Registration API allows you to delete user information from the Repro DB.

Note

The deletion process will begin approximately 6 days after Request Accepted Date, and the user will be excluded from the campaign target users. The deletion process will complete on the 7th of the following month after it starts. Depending on the date of Request Accepted Date, the deletion process may be completed on the 7th of the month following the two month in which Request Accepted Date.
If the same user information is sent between the time the Deletion Targeted User Registration API is executed and the time it is deleted, that information will be deleted as well.

Warning

The Deletion Targeted User Registration API cannot be canceled. Please use with caution.

Get Started¶

To use the Deletion Targeted User Registration API, you need to use the Repro API token.

Get the Repro API token¶

You can find the Repro API Token at SETTINGS > PRODUCT SETTINGS > Credentials

Warning

"REGISTER API TOKEN" makes the current API token unavailable. Once you do this operation, You never use the key again and revert to the previous state.

Register the users you want to delete.¶

Deletion Targeted User Registration API is associated to a single endpoint which accepts POST HTTP method.

POST https://api.reproio.com/v3/user_data_deletions

Authentication¶

Set Repro API Token in HTTP header X-Repro-Token.

Access limit per unit time¶

Access is limited per time for the Deletion Targeted User Registration API.

The limit is set to 1000 accesses for every 1 minutes per API token.
When the request is completed, there will be a notification at the X-RateLimit-Limit header showing the maximum number of requests per time.
When the request count exceeds the maximum access number, the following response HTTP Status 429 (Too Many Requests) will appear.

For more information on response headers, please see Deletion Targeted User Registration API responses.

Warning

The maximum access number may fluctuate without warning.
The access limit setting value is per API token per function.

For example, the push API and the user profile API use the same API token, but they are different functions, so even if they are requested at the same time, each is counted as one request.

API format¶

Set the message to HTTP body as JSON format.

identity_type: The user_id is fixed.
identity_value: Specify an array of the users registered by the User ID API in the app and website.
- the API will return HTTP Status 400 (Bad Request). For more details, see Deletion Targeted User Registration API responses.

Example of a payload for Deletion Targeted User Registration API¶

Register the users you want to delete.¶

{
  "identity_type": "user_id",
  "identity_value": "user-123"
}

Deletion Targeted User Registration API requests¶

Request header

The response header contains the following values.

Header	Description	Required
Content-Type	Set application/json	Required
X-Repro-Token	Set the token retrieved with Get the Repro API token	Required

Request body

Set the message to JSON format.

Deletion Targeted User Registration API responses¶

Response header

The response header contains the following values.

Status	Header	Description
Success	`X-RateLimit-Limit`	Access limit per unit time
Success	`X-RateLimit-Remaining`	The number of requests remaining in the current rate limit window.
Success	`X-RateLimit-Reset`	The time at which the current rate limit window resets in UTC epoch seconds. (Unix UTC timestamp)
Request limited	`Retry-After`	The time how long the user agent should wait before making a follow-up request.

Response body

The list below contains all status codes and error messages of Deletion Targeted User Registration API responses.

202 Accepted¶

The request was successful.

Response body

{
  "status": "accepted"
}

400 Bad Request¶

You have an error in your request. Please check you have spelled everything correctly.

Response body

{
  "error": {
    "messages": ["error message"]
  }
}

401 Unauthorized¶

You don't have Repro API Token set.

Response body

{
  "status": "unauthorized",
  "error": {
    "messages": [
      "Please include your Repro API Token as \"X-Repro-Token\" HTTP header."
    ]
  }
}

403 Forbidden¶

The specified Repro API Token is invalid.

Response body

{
  "status": "forbidden",
  "error": {
    "messages": [
      "Please check your Repro API Token as \"X-Repro-Token\" HTTP header."
    ]
  }
}

404 Not Found¶

The endpoint does not exist.

Response body

{
  "status": "not_found",
  "error": {
    "messages": [
      "Not found."
    ]
  }
}

415 Unsupported Media Type¶

The CSV file contains unacceptable data format. Please check if the Content-Type header as well as the request endpoint.

Response body

{
  "error": {
    "messages": ["The provided content-type '指定されたMime Type' is not supported."]
  }
}

429 Too Many Requests¶

Too many requests. Please wait the seconds indicated in the Retry-After header and make a follow-up request.

Response body

{
  "status": "too_many_requests",
  "error": {
      "messages": [
          "Too many requests hit the API too quickly."
      ]
  }
}

Receive an email when the deletion is complete¶

When the user deletion is complete, you will receive an email.

Note

Received when all deletion processes for the specified user have been completed.