SIM Configuration

Apply a SIM configuration to a single SIM card

Dispatches a configuration change to the specified SIM card. Non-admin users may only target a SIM card they can access and configurations allowed by their plan.

post/simcards/{simCardId}/configure/

Request

Base URL
https://dashboard.hologram.io/api/1
Auth
HTTP basic
TypeScript
https://skmtc.dev/hologram/apis/hologram-rest-api-v1/docs/simcards/:simCardId/configure/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

simCardIdinteger required

SIM card ID

Request body

configuration_idinteger required

ID of the SIM configuration to apply

immediateboolean

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_idinteger

Change the device plan simultaneously; requires zone and orgid

zonestring

Required when plan_id is provided

orgidinteger

Required when plan_id is provided

Response

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.