SIMs (Devices)

Change SIM state

Change the state of a SIM in a device. 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 the SIM card from service. Deactivation 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/{deviceId}/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/:deviceId/state/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

deviceIdinteger required

ID of the device

Request body

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

New state to set. Valid values are pause, live, or deactivate.

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.