SIMs (Devices)

Change SIM state (bulk)

Change the state of SIMs in multiple devices at once. Supported state values are pause, live, and deactivate.

Pausing the SIM will prevent your device from passing any data on all profiles installed on the SIM. Paused SIMs still incur Monthly Recurring Charges.

Deactivating permanently removes SIM cards from service and is supported from any non-deactivated state, including SIMs in Test Mode (network states of TEST-ACTIVATE, TEST-HIBERNATE, TEST-AUTOACTIVATE, and their -PENDING variants).

post/devices/state

Request

Base URL
https://dashboard.hologram.io/api/1
Auth
HTTP basic
TypeScript
https://skmtc.dev/hologram/apis/hologram-rest-api-v1/docs/devices/state/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

deviceidsinteger[] required

List of device IDs to update

state'pause' | 'live' | 'deactivate' required

The new state for all SIM cards on the devices. Valid values are pause, live, or deactivate. Deactivation is supported from any non-deactivated state, including preflight/test mode states (TEST-ACTIVATE, TEST-HIBERNATE, TEST-AUTOACTIVATE, and their -PENDING variants).

Example request

{
  "state": "pause"
}

Response

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.