Setting parental ratings thresholds

Request

To set or change the parental ratings threshold(s) on an account, send a PUT request to:

http://<host>:<port>/adm/v1/accounts/<accountID>

Headers

• Content-Type: application/json

Mandatory Arguments

• accountID

Other arguments

If you do not supply a value for a parameter that already has a value, it will be set to null.

So the recommended approach is to use a GET /adm/v1/accounts/<accountID> request to get the account, change or add the parentalControl block, then use this modified set of parameters in the body of the PUT request.

To change or add the account's parental ratings thresholds, include a parentalRatings block (or amend the existing one) in the body of the request:

"parentalControl": {
  "ratingThreshold": {
    "<ratings_body_name>": "<rating>",
    "<ratings_body_name>": "<rating>",
    ...
  }
}

Example

A PUT request that contains the following block in its payload sets the specified parental ratings thresholds for the account:

"parentalControl": {
  "ratingThreshold": {
    "FSK": "FSK12",
    "TVPG": "TV-MA"
  }
}

Response

A successful request returns an HTTP 200 status.

An unsuccessful request returns an HTTP 400 status. The response includes details of the error.

Example

{
    "matchedCount": 1,
    "modifiedCount": 1
}

See also

For full details of this API, see Account and Device Manager (ADM) API documentation.