v12

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-014994227.2 KB

phones

Rename a phone

Sets the human-readable display name on a private phone the caller's org owns. Returns the updated phone summary.

patch/phones/{phone_id}/nickname

Path parameters

phone_idstring required

device identifier

Request body

$schemastring uri

A URL to the JSON Schema for this object.

nicknamestring required

New display name for the device.

Example request

{
  "$schema": "/api/v1/PhoneUpdateNicknameRequest.json"
}

Response

$schemastring uri

A URL to the JSON Schema for this object.

created_atstring date-time required

When the phone record was created.

current_session_idstring nullable required

Session currently holding the phone, if allocated.

last_heartbeatstring date-time nullable required

Time of the phone's most recent heartbeat.

last_interaction_timestampstring date-time nullable required

Time of the most recent interaction on the phone.

locationstring nullable required

Physical hosting location of the phone.

model_idstring nullable required

Hardware model identifier.

model_namestring nullable required

Hardware model name.

nicknamestring nullable required

User-assigned nickname.

owner_organization_idstring nullable required

Owning organization, for private phones.

ownership_type'shared' | 'private' required

'shared' for pool phones, 'private' for dedicated rentals.

phone_idstring required

Phone identifier used by allocate and the phone APIs.

phone_namestring nullable required

Display name of the phone.

phone_type'android' | 'iphone' | 'unknown' nullable required

Platform of the phone.

rental_expires_atstring date-time nullable required

When the current rental ends, for rented phones.

status'active' | 'inactive' | 'maintenance' | 'suspended' required

Fleet status of the phone.

updated_atstring date-time required

When the phone record was last updated.

Example response

{
  "$schema": "/api/v1/PhoneSummary.json"
}