HOhologram
SIMs (Devices)

Update SIM names (bulk)

Bulk update SIM names. Either supply prefix to rename each selected device to {prefix} ({last 5 ICCID digits}) (or the prefix alone when skipPostfix is true), or supply names to set an explicit name per device. With prefix, devices are selected via deviceids, bulk-selection filters, or a combination of both; with names, the listed devices are renamed and all selection parameters are ignored. Requires the bulk_rename feature flag on the organization.

post/devices/names

Request

Query parameters

previewboolean

When true, return a sample of devices that would be renamed without making changes

Request body

deviceidsinteger[]

Explicit list of device IDs to include in the selection.

allSelectedboolean

When true, select all devices in the organization (subject to excludedDeviceIds).

useSearchboolean

When true, resolve the device selection from the search index using deviceFilters instead of the database.

excludedDeviceIdsinteger[]

Device IDs to exclude from the bulk selection.

pagesSelectedinteger[]

Top-level page numbers selected; presence triggers bulk device selection.

prefixstring

String prepended to every renamed device. The last 5 digits of the active ICCID are appended in parentheses unless skipPostfix is true. Required unless names is provided.

skipPostfixboolean

When true, set each device name to the prefix exactly, with no ICCID suffix appended.

linkidsinteger[]

Profile cellular link IDs to include in the selection.

Response

OK

successboolean

Indicates whether the request was successful.

Example response

{
  "success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.