Update SIM names (bulk)

curl --request POST \
  --url https://dashboard.hologram.io/api/1/devices/names \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "deviceids": [
    123
  ],
  "allSelected": true,
  "useSearch": true,
  "deviceFilters": {
    "limit": 123,
    "pageIdsSelected": [
      123
    ],
    "pagesSelected": [
      123
    ],
    "states": [
      "<string>"
    ],
    "hitsPerPage": 123,
    "orgid": 123,
    "query": "<string>",
    "sort": {},
    "filters": {}
  },
  "excludedDeviceIds": [
    123
  ],
  "pagesSelected": [
    123
  ],
  "prefix": "<string>",
  "names": [
    {
      "deviceid": 123,
      "name": "<string>"
    }
  ],
  "skipPostfix": true,
  "linkids": [
    123
  ]
}
'

import requests

url = "https://dashboard.hologram.io/api/1/devices/names"

payload = {
    "deviceids": [123],
    "allSelected": True,
    "useSearch": True,
    "deviceFilters": {
        "limit": 123,
        "pageIdsSelected": [123],
        "pagesSelected": [123],
        "states": ["<string>"],
        "hitsPerPage": 123,
        "orgid": 123,
        "query": "<string>",
        "sort": {},
        "filters": {}
    },
    "excludedDeviceIds": [123],
    "pagesSelected": [123],
    "prefix": "<string>",
    "names": [
        {
            "deviceid": 123,
            "name": "<string>"
        }
    ],
    "skipPostfix": True,
    "linkids": [123]
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    deviceids: [123],
    allSelected: true,
    useSearch: true,
    deviceFilters: {
      limit: 123,
      pageIdsSelected: [123],
      pagesSelected: [123],
      states: ['<string>'],
      hitsPerPage: 123,
      orgid: 123,
      query: '<string>',
      sort: {},
      filters: {}
    },
    excludedDeviceIds: [123],
    pagesSelected: [123],
    prefix: '<string>',
    names: [{deviceid: 123, name: '<string>'}],
    skipPostfix: true,
    linkids: [123]
  })
};

fetch('https://dashboard.hologram.io/api/1/devices/names', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const url = 'https://dashboard.hologram.io/api/1/devices/names';
const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    deviceids: [123],
    allSelected: true,
    useSearch: true,
    deviceFilters: {
      limit: 123,
      pageIdsSelected: [123],
      pagesSelected: [123],
      states: ['<string>'],
      hitsPerPage: 123,
      orgid: 123,
      query: '<string>',
      sort: {},
      filters: {}
    },
    excludedDeviceIds: [123],
    pagesSelected: [123],
    prefix: '<string>',
    names: [{deviceid: 123, name: '<string>'}],
    skipPostfix: true,
    linkids: [123]
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

{
  "success": true
}

Bulk actions

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

curl --request POST \
  --url https://dashboard.hologram.io/api/1/devices/names \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "deviceids": [
    123
  ],
  "allSelected": true,
  "useSearch": true,
  "deviceFilters": {
    "limit": 123,
    "pageIdsSelected": [
      123
    ],
    "pagesSelected": [
      123
    ],
    "states": [
      "<string>"
    ],
    "hitsPerPage": 123,
    "orgid": 123,
    "query": "<string>",
    "sort": {},
    "filters": {}
  },
  "excludedDeviceIds": [
    123
  ],
  "pagesSelected": [
    123
  ],
  "prefix": "<string>",
  "names": [
    {
      "deviceid": 123,
      "name": "<string>"
    }
  ],
  "skipPostfix": true,
  "linkids": [
    123
  ]
}
'

import requests

url = "https://dashboard.hologram.io/api/1/devices/names"

payload = {
    "deviceids": [123],
    "allSelected": True,
    "useSearch": True,
    "deviceFilters": {
        "limit": 123,
        "pageIdsSelected": [123],
        "pagesSelected": [123],
        "states": ["<string>"],
        "hitsPerPage": 123,
        "orgid": 123,
        "query": "<string>",
        "sort": {},
        "filters": {}
    },
    "excludedDeviceIds": [123],
    "pagesSelected": [123],
    "prefix": "<string>",
    "names": [
        {
            "deviceid": 123,
            "name": "<string>"
        }
    ],
    "skipPostfix": True,
    "linkids": [123]
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    deviceids: [123],
    allSelected: true,
    useSearch: true,
    deviceFilters: {
      limit: 123,
      pageIdsSelected: [123],
      pagesSelected: [123],
      states: ['<string>'],
      hitsPerPage: 123,
      orgid: 123,
      query: '<string>',
      sort: {},
      filters: {}
    },
    excludedDeviceIds: [123],
    pagesSelected: [123],
    prefix: '<string>',
    names: [{deviceid: 123, name: '<string>'}],
    skipPostfix: true,
    linkids: [123]
  })
};

fetch('https://dashboard.hologram.io/api/1/devices/names', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const url = 'https://dashboard.hologram.io/api/1/devices/names';
const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    deviceids: [123],
    allSelected: true,
    useSearch: true,
    deviceFilters: {
      limit: 123,
      pageIdsSelected: [123],
      pagesSelected: [123],
      states: ['<string>'],
      hitsPerPage: 123,
      orgid: 123,
      query: '<string>',
      sort: {},
      filters: {}
    },
    excludedDeviceIds: [123],
    pagesSelected: [123],
    prefix: '<string>',
    names: [{deviceid: 123, name: '<string>'}],
    skipPostfix: true,
    linkids: [123]
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

{
  "success": true
}

Authorizations

Authorization

string

header

required

HTTP Basic authentication using API keys. Set the username to apikey and the password to your API key. You can find your API key on the Hologram Dashboard under Account Settings.

Query Parameters

preview

boolean

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

Body

application/json

Top-level parameters for bulk device selection via BulkSelection. Explicit deviceids are merged with filter-based selection. Some endpoints require a feature flag (e.g. bulk_rename, bulk_tag) before bulk selection is enabled.

deviceids

integer[]

Explicit list of device IDs to include in the selection.

allSelected

boolean

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

useSearch

boolean

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

deviceFilters

object

Filter criteria for bulk device selection via BulkSelection. When resolved from the database (default), accepts the same filter fields as GET /devices (e.g. states, tagids, planid). When useSearch is true, also accepts search-index filter fields (e.g. links_cur_billing_data_used).

Show child attributes

excludedDeviceIds

integer[]

Device IDs to exclude from the bulk selection.

pagesSelected

integer[]

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

prefix

string

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.

names

object[]

Explicit per-device names. When provided, each listed device is renamed to exactly its supplied name and the prefix and device-selection parameters are ignored.

Show child attributes

skipPostfix

boolean

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

linkids

integer[]

Profile cellular link IDs to include in the selection.

Response

success

boolean

Indicates whether the request was successful.

Example:

true