Skip to main content
Skip table of contents

Add/remove devices to/from the approved devices list

Request

To add devices to and/or remove devices from the account's approved devices list, send a POST request to:

CODE
https://<host>:<port>/adm/v1/user/devices/amendapprovals

Headers

  • x-correlation-id – identifier for logging, to correlate messages across a call flow
  • nv-tenant-id – the tenant ID
  • token – request authentication token

Mandatory arguments

One or both of the following:

  • deviceToApprove – the ID of the device to be added to the approved devices list (in body)

  • deviceToUnapprove – the ID of the device to be removed from the approved devices list (in body)

Other arguments

None

Example

A POST request with this payload will add the device with the ID 123 to the approved devices list and remove the device with ID 456:

CODE
{
  "deviceToApprove": "123",
  "deviceToUnapprove "456"
}

Response

A successful request returns an HTTP 201 status.

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 specified device does not exist, the request returns an HTTP 404 status.

See also

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

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.