HOhologram
SIMs (Devices)

Activate SIMs (bulk)

Activate SIMs by ICCID range, individual ICCID list, or EID range. Any ICCID of a profile manufactured on the SIM can be used to activate a SIM. Maximum of 2,500 SIMs per request. Once a SIM is activated, you can begin passing data. plan and zone are required for all live activations. The start and end ICCID in a range must be real ICCIDs.

post/links/cellular/bulkclaim

Request

Request body

simsstring[]

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

simrangestring

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.

eidrangestring

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

planinteger

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

zonestring

Coverage zone of the plan. Required for live activations.

overage_limitinteger

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)

smslimitnumber

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

thresholdnumber

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

tagidinteger

Tag ID to apply to every activated SIM.

invalidatePreflightSimsboolean

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.

Example request

{
  "simrange": "89330123456789012345-89330123456789012365",
  "zone": "global"
}

Response

OK

successboolean

Indicates whether the request was successful.

Example response

{
  "success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.