Enable/disable NPVR for multiple accounts

Request

To enable or disable NPVR for multiple accounts, send a PUT request to:

https://<host>:<port>/adm/v1/accounts?filter=<filter>

Headers

Content-Type: application/json

Mandatory arguments

filter – filter to specify the accounts for which NPVR is to be enabled or disabled. This is a JSON object containing one or more key/value pairs, separated by commas. You can use any account field in the filter expression (as returned by GET account – see the ADM API documentation).

Other arguments

pvrStatus – the NPVR status to be applied to the account (ENABLED to enable, DISABLED to disable)

Example

A PUT request to the following URL with the payload below enables NPVR for all accounts that have both a status of ACTIVE and the account profile called DEFAULT.

URL

https://<host>:<port>/adm/v1/accounts?filter={"status": "ACTIVE","accountProfileId":"DEFAULT"}

Payload

CODE

{
  "pvrStatus": "ENABLED"
}

Response

A successful request returns an HTTP 200 status.

For example:

CODE

{
  "matchedCount": 19227,
  "modifiedCount": 19227
}

A bad request returns an HTTP 400 status.

An unauthorised request returns an HTTP 401 status.

A forbidden request returns an HTTP 403 status.

If the account cannot be found, the request returns an HTTP 404 status.