Retire a device
Retire (decommission) a device: it is unassigned from its owner, renamed to deviceName, marked retired and taken out of stock, with condition and notes recorded; putDeviceBackInStock reverts it. The device must not be enrolled in MDM: an enrolled device is refused with 409, but the unassignment and rename are applied before that check and are kept, so disenroll it first (disenrollDevice) and wait until it no longer reads as enrolled. When the company has MDM, dataAction WIPE, SOFT_WIPE or HARD_WIPE sends a wipe; LOCK, NOTHING or no value sends a disenroll instead — no lock command is sent. A wipe needs the MDM host record that a completed disenrollment removes: without it the call fails with 502 after the retirement is recorded.
Authorizations
Use your Primo API key in the Authorization header as Bearer <API_KEY>.
Path Parameters
Body
New name to assign to the device after retirement
WIPE, SOFT_WIPE or HARD_WIPE sends an MDM wipe during retirement; LOCK, NOTHING or no value sends an MDM disenroll instead. A wipe needs the MDM host record that a completed disenrollment removes, and fails with 502 without it.
WIPE, SOFT_WIPE, HARD_WIPE, LOCK, NOTHING Physical condition of the device
BROKEN, FAIR, GOOD, EXCELLENT Optional notes about the retirement