Update Device Nickname

PUT {{apiPath}}/environments/{{envID}}/users/{{userID}}/devices/{{deviceID}}/nickname

The operation PUT /environments/{{envID}}/users/{{userID}}/devices/{{deviceID}}/nickname updates nickname, the only mutable property for a device.

Prerequisites

PropertyTypeRequired?
nicknameStringRequired

See the Device properties data model for full property descriptions.

Request Body

{"nickname"=>"My phone"}

RESPONSES

status: OK

{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8376797d-641c-4e7b-8bc1-2fdf71916cab/devices/eaae1190-b42f-427c-bf92-d5fa5fd9c288/nickname"},"device":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8376797d-641c-4e7b-8bc1-2fdf71916cab/devices/eaae1190-b42f-427c-bf92-d5fa5fd9c288"}},"nickname":"My phone"}