SIMs (Devices)

Update location / Network refresh

Triggers an update location command for the specified profiles, using the cellular link ID for each profile. Update location / network refresh commands are not supported by all carriers. Only profiles in a LIVE, TEST-ACTIVATE, or TEST-AUTOACTIVATE network state can open data sessions and are eligible for this command, other states will fail.

post/links/cellular/updatelocation

Request

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

Query parameters

previewboolean

When true, run every validation check without triggering the carrier location update. Use this to confirm a selection is eligible before committing to it — an error response here means the real (non-preview) request would also fail.

Request body

linkidsinteger[] required

List of profiles to update via their cellular link IDs (up to 10)

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.