Skip to main content
POST
/
devices
/
batch
/
state
Pause, resume, or deactivate devices (bulk)
curl --request POST \
  --url https://dashboard.hologram.io/api/1/devices/batch/state \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "success": true,
  "data": {
    "preview": false,
    "valid_tasks": [
      {
        "endpoint": "/1/devices/state",
        "params": {
          "state": "pause",
          "deviceids": [
            2
          ],
          "in_transaction": true
        },
        "error": false,
        "adding_balance": false,
        "index": 0,
        "task_results": {
          "warnings": [
            {
              "deviceid": 2,
              "linkid": 3,
              "message": "SIM state is locked (PAUSED-PENDING-USER). Contact support"
            }
          ],
          "devices_modified": [],
          "profiles_modified": [],
          "newstate": ""
        }
      }
    ],
    "jobid": "3"
  }
}
'
{
  "data": {
    "valid_tasks": [
      {
        "endpoint": "<string>",
        "params": {
          "state": "<string>",
          "in_transaction": true,
          "deviceids": [
            123
          ]
        },
        "error": true,
        "adding_balance": true,
        "index": 123,
        "task_results": {
          "warnings": [
            "<string>"
          ],
          "devices_modified": [
            123
          ],
          "profiles_modified": [
            123
          ],
          "newstate": "<string>"
        }
      }
    ],
    "jobid": "<string>",
    "preview": true
  },
  "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

orgid
number
required

Body

application/json
state
enum<string>

The state to change devices to. Must be one of pause, resume, or deactivate.

Warning: Deactivation is permanent and irreversible. After a SIM is deactivated, its profiles are released by carriers and the SIM will need to be physically replaced.

Available options:
pause,
resume,
deactivate
Example:

"pause"

deviceids
integer[]

Array of device IDs to change state for

Example:
[12345, 67890]
orgid
integer

Organization ID to perform the bulk operation within

Example:

12345

Response

200 - application/json

Successful response

data
Data · object
success
boolean

Whether the request was successful or not

Example:

true