Activate devices (bulk)

curl --request POST \
  --url https://dashboard.hologram.io/api/1/links/cellular/bulkclaim \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: */*' \
  --data '
{
  "invalidatePreflightSims": false,
  "orgid": 12345,
  "overage_limit": 100000,
  "plan": 9876,
  "simrange": "89330123456789012345-89330123456789012365",
  "smslimit": 10,
  "tagid": 5432,
  "threshold": 100000,
  "zone": "global"
}
'

{
  "data": [
    {
      "Devices": 98765,
      "link": 54321,
      "sim": "89123400006789012345"
    },
    {
      "Devices": 98766,
      "link": 54322,
      "sim": "89123400006789012346"
    }
  ],
  "order_data": {
    "sales_tax": 0,
    "shipping_cost": 0
  },
  "success": true
}

Bulk actions

Activate devices (bulk)

Activate SIMs by ICCID range, or a list of SIMs. For a range, best used to activate 10, 100, or 1000 pack of SIMs ordered together. Include first and last ICCIDs to be activated (printed on SIM pack). Activates SIMs within an ICCID range on the cellular network. Once a SIM is activated, you can begin to pass data. Any monthly charges and data usage charges will take effect. If you are activating SIMs on a plan that has a monthly fee, your account will be immediately charged the monthly fee for all devices you are activating. If your account does not have enough balance to cover these charges, the request will fail. Activating a SIM creates a new device, SIM, and profiles (referenced through cellular links).

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: */*' \
  --data '
{
  "invalidatePreflightSims": false,
  "orgid": 12345,
  "overage_limit": 100000,
  "plan": 9876,
  "simrange": "89330123456789012345-89330123456789012365",
  "smslimit": 10,
  "tagid": 5432,
  "threshold": 100000,
  "zone": "global"
}
'

{
  "data": [
    {
      "Devices": 98765,
      "link": 54321,
      "sim": "89123400006789012345"
    },
    {
      "Devices": 98766,
      "link": 54322,
      "sim": "89123400006789012346"
    }
  ],
  "order_data": {
    "sales_tax": 0,
    "shipping_cost": 0
  },
  "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.

Body

*/*

invalidatePreflightSims

boolean

Modifies the returned error message when validating Test Mode SIMs for activation with 'Preflight SIM'. If the flag is set to true, Test Mode SIMs will always be marked as invalid when going through the activation flow.

orgid

number

Specify the organization to activate the plan on. Your API key must have activation role privileges on the target organization

overage_limit

number

Amount of overage to consume before pausing, -1 for unlimited (default). Setting overage limits are only available for customers without the bmp_feature_lite_data_usage_limits feature flag.

plan

number

Device data plan. Look up plan IDs using the List Data Plans endpoint.

simrange

string

Range of ICCIDs to activate

eidrange

string

Range of eUICCID (EID) numbers to activate

sims

string[]

List of ICCIDs to activate. This would be used in place of simrange, not in conjunction.

ICCID of SIM to activate

smslimit

number

Amount of SMS to consume before pausing, -1 for unlimited (default)

tagid

number

Add a tag specified by the tag ID

threshold

number

Amount of data to consume before alerting, should be less than overage, -1 for unlimited (default)

zone

string

The default value is 'global'. Reference /plans endpoint for valid zones available with each plan.

Response

200 - application/json

data

object[]

order_data

object

success

boolean

Whether the request was successful or not

Example:

true

⌘I