Skip to main content
POST
/
links
/
cellular
/
bulkclaim
Activate devices (bulk)
curl --request POST \
  --url https://dashboard.hologram.io/api/1/links/cellular/bulkclaim \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sims": [
    "<string>"
  ],
  "simrange": "89330123456789012345-89330123456789012365",
  "eidrange": "<string>",
  "plan": 123,
  "zone": "global",
  "overage_limit": 123,
  "smslimit": 123,
  "threshold": 123,
  "tagid": 123,
  "invalidatePreflightSims": true
}
'
{
  "success": true,
  "data": [
    {
      "simcardid": "<string>",
      "device": 123,
      "link": 123,
      "sim": "<string>"
    }
  ]
}

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 SIM ICCIDs to activate. Exactly one of sims, simrange, or eidrange is required.

​
simrange
string

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

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

Availability zone for the plan. Required for live activations.

Example:

"global"

​
overage_limit
integer

Data overage limit in bytes. -1 for unlimited.

​
smslimit
number

SMS limit. -1 for unlimited.

​
threshold
number

Data alert threshold in bytes. An alert is triggered when usage exceeds this value.

​
tagid
integer

Tag ID to apply to every activated device.

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