Skip to main content
POST
Retire a device
Key: Write Scope: Company

Authorizations

Authorization
string
header
required

Use your Primo API key in the Authorization header as Bearer <API_KEY>.

Path Parameters

deviceId
string
required

Body

application/json
deviceName
string
required

New name to assign to the device after retirement

dataAction
enum<string> | null

Action to take on device data during retirement (wipe, lock, etc.)

Available options:
WIPE,
SOFT_WIPE,
HARD_WIPE,
LOCK,
NOTHING
condition
enum<string> | null

Physical condition of the device

Available options:
BROKEN,
FAIR,
GOOD,
EXCELLENT
notes
string | null

Optional notes about the retirement

Response

default - application/json
success
boolean
required