Skip to main content
POST
/
devices
/
names
Update device 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 '
{
  "prefix": "<string>",
  "allSelected": true,
  "deviceFilters": {
    "limit": 123,
    "pageIdsSelected": [
      123
    ],
    "pagesSelected": [
      123
    ],
    "states": [
      "<string>"
    ],
    "hitsPerPage": 123,
    "orgid": 123,
    "query": "<string>",
    "sort": {
      "links_cur_billing_data_used": "ASC"
    },
    "filters": {
      "field": "id",
      "operator": "BETWEEN",
      "value": "<string>"
    }
  },
  "deviceids": [
    123
  ],
  "excludedDeviceIds": [
    123
  ],
  "linkids": [
    123
  ],
  "pagesSelected": [
    123
  ],
  "useSearch": true
}
'
{
  "success": true,
  "data": {
    "total_devices_count": 30,
    "devices_sample": [
      {
        "name": "Loose Bag (61144)",
        "iccid": "8912340000987661144"
      },
      {
        "name": "Unnamed Device (58561)",
        "iccid": "8912340000987658561"
      },
      {
        "name": "Device (58595)",
        "iccid": "8912340000987658595"
      },
      {
        "name": "Phone Hotspot (59338)",
        "iccid": "8912340000987659338"
      },
      {
        "name": "smtc (66713)",
        "iccid": "8912340000987666713"
      },
      {
        "name": "smtc (66721)",
        "iccid": "8912340000987666721"
      },
      {
        "name": "tmo-hq (17037)",
        "iccid": "8912340000987617037"
      },
      {
        "name": "Data Consumer (51509)",
        "iccid": "8912340000987651509"
      },
      {
        "name": "Dom Test SIM 3",
        "iccid": "8912340000987652125"
      }
    ]
  }
}

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
integer

Body

application/json

Union representation of the various ways that devices can be selected from the device table in Dashboard. Note that if useSearch=false, only orgid, states, limit, startafter, allSelected, excludedDeviceIds, linkIds and pageIdsSelected are relevant.

​
prefix
string
required

Prefix for new device name.

​
allSelected
boolean
​
deviceFilters
object
​
deviceids
integer[]
​
excludedDeviceIds
integer[]
​
linkids
integer[]
​
pagesSelected
integer[]
​
useSearch
boolean

Response

200 - application/json

Previewed response with information around selected devices or successful response