curl --request POST \
--url https://dashboard.hologram.io/api/1/links/cellular/bulkclaim \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"invalidatePreflightSims": false,
"orgid": 12345,
"overage_limit": 100000,
"plan": 9876,
"simrange": "89330123456789012345-89330123456789012365",
"smslimit": 10,
"tagid": 5432,
"threshold": 100000,
"zone": "global"
}
'{
"data": [
{
"simcardid": 11111,
"device": 98765,
"link": 54321,
"sim": "89123400006789012345"
},
{
"simcardid": 11112,
"device": 98766,
"link": 54322,
"sim": "89123400006789012346"
}
],
"order_data": [
{
"sales_tax": 0,
"shipping_cost": 0
}
],
"success": true
}Activate devices (bulk)
Activate SIMs by ICCID range, individual ICCID list, or EID range.
For a range, best used to activate 10, 100, or 1000 packs of SIMs ordered together. Include the first and last ICCIDs to be activated (printed on SIM pack).
Once a SIM is activated, you can begin passing data. Any monthly charges and data usage charges will take effect immediately. 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).
Required input: Provide exactly one of simrange, eidrange, or sims.
Required fields: plan and zone are required for all live activations. Omit them only when using preview=true to preview which SIMs would be activated.
Limit: Maximum of 2,500 SIMs per request.
curl --request POST \
--url https://dashboard.hologram.io/api/1/links/cellular/bulkclaim \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"invalidatePreflightSims": false,
"orgid": 12345,
"overage_limit": 100000,
"plan": 9876,
"simrange": "89330123456789012345-89330123456789012365",
"smslimit": 10,
"tagid": 5432,
"threshold": 100000,
"zone": "global"
}
'{
"data": [
{
"simcardid": 11111,
"device": 98765,
"link": 54321,
"sim": "89123400006789012345"
},
{
"simcardid": 11112,
"device": 98766,
"link": 54322,
"sim": "89123400006789012346"
}
],
"order_data": [
{
"sales_tax": 0,
"shipping_cost": 0
}
],
"success": true
}Documentation Index
Fetch the complete documentation index at: https://docs.hologram.io/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
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
Range of ICCIDs to activate (format <first_iccid>-<last_iccid>). Provide exactly one of simrange, sims, or eidrange.
List of ICCIDs to activate. Provide exactly one of simrange, sims, or eidrange.
ICCID of SIM to activate
Range of eUICCID (EID) numbers to activate. Provide exactly one of simrange, sims, or eidrange.
Data plan ID to activate on. Look up plan IDs using the List Data Plans endpoint. Required for live activations.
Zone for the plan. Defaults to global. Reference the /plans endpoint for valid zones available with each plan. Required for live activations.
Organization to activate SIMs on. Your API key must have activation role privileges on the target organization.
Amount of data (bytes) to consume before pausing. Use -1 for unlimited (default).
Only available for accounts without the bmp_feature_lite_data_usage_limits feature flag.
Number of SMS messages allowed before pausing. Use -1 for unlimited (default).
Data usage alert threshold in bytes. Should be less than overage_limit. Use -1 for no threshold (default).
ID of a tag to apply to the newly activated devices.
When true, Test Mode SIMs will always be marked as invalid in the activation validation flow.
Was this page helpful?