Release Device | Legacy

Restriction: This API endpoint is not supported in the public cloud.
Restriction: This API endpoint is not supported in the Free Trial cloud.

Forcefully releases the device specified by <deviceId>. The device is either allocated to the user or the user is an administrator.

Users can only release devices accessible by their roles.

URL

Copy 
https://<your-cloud>.perfectomobile.com/services/handsets/<deviceId>?operation=release&securityToken=value

Method

POST

Request parameters

Name

Type

Default

Description

securityToken*

string

A unique cryptographic key assigned to an authorized user.

admin

boolean

false

true to allow an administrator to release a device allocated to a user he administers.

* Mandatory parameter

Request response

The status response is either success or an error condition.

An error is returned in the following cases:

  • The device is not found.
  • The device is not accessible to the user by his roles.
  • The device is not connected.
  • The device is not in use.
  • The device is not allocated to the user (in user mode).
  • The admin is not a user administrator for the user (in admin mode).
Copy

Handset information format

{ 
  "status":"success" 
}