Skip to main content

​
How to activate multiple SIMs in bulk using the REST API

Use the Hologram REST API to activate dozens or thousands of SIMs in a single request. You can submit explicit ICCID lists or ICCID ranges, and specify the data plan and zone to apply.
Note: You can also perform bulk actions in the Dashboard for smaller jobs.
If you aren’t familiar with APIs, we highly recommend checking out our introduction to Hologram’s REST API guide as well as using Postman to make the API calls mentioned in this guide.

​
Prerequisites

  • API key with permission to manage SIMs
  • Organization ID where the SIMs belong
  • Plan ID and zone for the target plan (see below)
1

​
Find your plan ID and zone

Use the plans endpoint to list available plans. Find the id and the zones value (for example: global, USA, usaall, 1, or 2). Plans should generally have only one zone.
cURL
curl --request GET \
  --url 'https://dashboard.hologram.io/api/1/plans' \
  -u apikey:YOUR_HOLOGRAM_API_KEY
Response example
{
  "success": true,
  "limit": 1,
  "size": 1,
  "continues": true,
  "links": {
    "path": "/api/1/plans",
    "base": "dashboard.hologram.io",
    "next": "/api/1/plans?startafter=2345"
  },
  "lastid": 2345,
  "data": [
    {
      "id": 2345,
      "partnerid": 1,
      "name": "Global G3 Standard Network-Level Billing",
      "description": "Global G3 Standard Network-Level Billing",
      "data": 0,
      "recurring": 1,
      "enabled": 1,
      "billingperiod": 1,
      "groupid": 1234,
      "developerplan": 0,
      "tiers": {
        "BASE": {
          "devicecount": 0,
          "zones": {
            "global": {
              "amount": "1.000000",
              "sms": "0.190000",
              "overage": "0.030000",
              "carriers": {
                "13": {
                  "apn": "hologram"
                }
              }
            }
          }
        }
      },
      "display_category": "standard",
      "cellular_coverage_region": {
        "id": 1,
        "display_name": "Global",
        "description": "Connect your SIM anywhere in the world"
      }
    }
  ]
}
2

​
Activate SIMs

​
Activate SIMs with an explicit ICCID list

Send a POST request to the bulk claim endpoint with a list of ICCIDs.
cURL
curl --request POST \
  --url 'https://dashboard.hologram.io/api/1/links/cellular/bulkclaim' \
  -u apikey:YOUR_HOLOGRAM_API_KEY \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "sims": ["8901000000000000001", "8901000000000000002"],
    "plan": 1234,
    "zone": "global",
    "orgid": 5678
  }'

​
Activate SIMs with an ICCID range

Alternatively, submit a range for contiguous ICCIDs.
cURL
curl --request POST \
  --url 'https://dashboard.hologram.io/api/1/links/cellular/bulkclaim' \
  -u apikey:YOUR_HOLOGRAM_API_KEY \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "simrange": "8901000000000000001-8901000000000000099",
    "plan": 1234,
    "zone": "global",
    "orgid": 5678
  }'
Warning: Use the correct plan and zone to avoid unexpected charges. Verify a subset before running very large batches.

End testing and activate SIMs in your dashboard

How to activate SIMs in your dashboard

Change SIM data plans in bulk using the REST API

How to change SIM data plans in bulk using the REST API