curl --request POST \
--url https://dashboard.hologram.io/api/1/simcards/configure \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"configuration_id": 5,
"simcard_ids": [
891011
],
"immediate": true
}
'{
"success": true,
"data": {
"requested_deviceids": [
1234567,
1234568
],
"requested_simcardids": [
891011,
891012
],
"warnings": []
}
}Configure one or more SIM Cards
Apply an eUICC SIM configuration to up to 250 SIM cards in a single request. The configuration determines the enabled carrier, fallback carrier, and any disabled carriers for each SIM.
All SIM cards must belong to devices accessible to the caller. Users may only reference configurations linked to their plan(s).
These operations are triggered by a usage update (new session, or session update) on the sim card by default, this helps to verify the sim is ready to receive the configuration. Pass immediate: true to execute synchronously and bypass the usage trigger, if there is a backlog of euicc operations, this may result in a rate limit error.
Callers are restricted to a single SIM card per immediate request.
Optionally, a plan change may be performed at the same time by providing plan_id, zone, and orgid. When plan_id is set, zone and orgid are also required.
Devices that cannot be configured (e.g. a pending eUICC operation) are skipped and reported in the warnings array. The request succeeds as long as at least one SIM card was processed successfully.
curl --request POST \
--url https://dashboard.hologram.io/api/1/simcards/configure \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"configuration_id": 5,
"simcard_ids": [
891011
],
"immediate": true
}
'{
"success": true,
"data": {
"requested_deviceids": [
1234567,
1234568
],
"requested_simcardids": [
891011,
891012
],
"warnings": []
}
}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
Request body for configuring eUICC SIM cards. Applies an enabled carrier, fallback carrier, and disabled carriers to the specified SIM cards.
ID of the SIM configuration to apply.
5
IDs of the SIM cards to configure. Maximum of 250.
250[891011, 891012]Validity period (in seconds) for profile download operations triggered by this configuration request. If omitted, the service default is used.
86400
When true, the configuration is executed synchronously, bypassing the eUICC usage queue. When false (default), the request is queued. Users may only use immediate: true for a single SIM card.
Optional plan ID to change each SIM card to before applying the configuration. When provided, zone and orgid are also required.
99
Zone for the new plan. Required when plan_id is provided.
"global"
Organization ID for the new plan. Required when plan_id is provided.
144
Was this page helpful?