Skip to main content
POST
Change SIM state (batch)

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.

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[]
required

Explicit list of device IDs to include in the selection.

state
string
required

New state: pause, live, or deactivate

allSelected
boolean

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

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).

excludedDeviceIds
integer[]

Device IDs to exclude from the bulk selection.

pagesSelected
integer[]

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

Response

OK

success
boolean

Indicates whether the request was successful.

Example:

true

data
object