Skip to main content
POST
Activate SIMs (bulk)

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
sims
string[]

List of profile ICCIDs on SIMs to activate. Exactly one of sims, simrange, or eidrange is required.

simrange
string

Inclusive ICCID range of profiles on SIMs to activate, formatted as {first}-{last}. Exactly one of sims, simrange, or eidrange is required. ICCIDs must be real ICCIDs.

Example:

"89330123456789012345-89330123456789012365"

eidrange
string

Inclusive EID range to activate, formatted as {first}-{last}. Exactly one of sims, simrange, or eidrange is required.

plan
integer

Data plan ID to assign to each activated SIM. Required for live activations.

zone
string

Coverage zone of the plan. Required for live activations.

Example:

"global"

overage_limit
integer

Additional bytes of data allowed above the plan's included data; SIM pauses when usage exceeds plan included data plus this value (-1 for unlimited, 0 for plan included data only)

smslimit
number

Maximum number of SMS messages allowed, within the organization's SMS limit; SIM is paused when this limit is reached (-1 for no limit)

threshold
number

Data warning threshold in bytes. An event is created when data usage exceeds this value (-1 for no threshold)

tagid
integer

Tag ID to apply to every activated SIM.

invalidatePreflightSims
boolean

When true, SIMs currently in preflight (test mode) are treated as new live activations rather than test-to-live transitions. Preflight plan and zone are replaced with the values provided in this request.

Response

OK

success
boolean

Indicates whether the request was successful.

Example:

true

data
object[]