Skip to main content
POST
/
simcards
/
configure
Apply a SIM configuration to one or more SIM cards
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": 123,
  "simcard_ids": [
    123
  ],
  "immediate": true,
  "plan_id": 123,
  "zone": "<string>",
  "orgid": 123
}
'
{
  "success": true,
  "data": {
    "requested_deviceids": [
      123
    ],
    "requested_simcardids": [
      123
    ],
    "async_request_id": 123,
    "child_ids": [
      123
    ],
    "warnings": [
      "<string>"
    ]
  }
}

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

application/json
configuration_id
integer
required

ID of the SIM configuration to apply

simcard_ids
integer[]
required

SIM card IDs to configure (max 250)

immediate
boolean

Skip the configuration queue; by default operations are queued at the time of the next usage update. If set and our backend is too busy to process the request in realtime this endpoint will return a 429 rate limit error until there is space for the request.

plan_id
integer

Change the device plan simultaneously; requires zone and orgid

zone
string

Required when plan_id is provided

orgid
integer

Required when plan_id is provided

Response

OK

success
boolean

Indicates whether the request was successful.

Example:

true

data
object