Sign in

v47

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-181,0851,7264.5 MB
SIM Cards

Update a SIM card

Updates SIM card data

patch/sim_cards/{id}

Path parameters

idstring uuid required
Example:6a09cdc3-8948-47f0-aa62-74ac943d6c58

Identifies the SIM.

Request body

idstring uuid

Identifies the resource.

record_typestring
type'physical' | 'esim'

The type of SIM card

iccidstring

The ICCID is the identifier of the specific SIM card/chip. Each SIM is internationally identified by its integrated circuit card identifier (ICCID). ICCIDs are stored in the SIM card's memory and are also engraved or printed on the SIM card body during a process called personalization.

imsistring

SIM cards are identified on their individual network operators by a unique International Mobile Subscriber Identity (IMSI). <br/> Mobile network operators connect mobile phone calls and communicate with their market SIM cards using their IMSIs. The IMSI is stored in the Subscriber Identity Module (SIM) inside the device and is sent by the device to the appropriate network. It is used to acquire the details of the device in the Home Location Register (HLR) or the Visitor Location Register (VLR).

msisdnstring

Mobile Station International Subscriber Directory Number (MSISDN) is a number used to identify a mobile phone number internationally. <br/> MSISDN is defined by the E.164 numbering plan. It includes a country code and a National Destination Code which identifies the subscriber's operator.

sim_card_group_idstring uuid

The group SIMCardGroup identification. This attribute can be <code>null</code> when it's present in an associated resource.

tagsstring[]

Searchable tags associated with the SIM card

authorized_imeisstring[] nullable

List of IMEIs authorized to use a given SIM card.

current_imeistring

IMEI of the device where a given SIM card is currently being used.

actions_in_progressboolean

Indicate whether the SIM card has any pending (in-progress) actions.

created_atstring

ISO 8601 formatted date-time indicating when the resource was created.

updated_atstring

ISO 8601 formatted date-time indicating when the resource was updated.

ipv4string

The SIM's address in the currently connected network. This IPv4 address is usually obtained dynamically, so it may vary according to the location or new connections.

ipv6string

The SIM's address in the currently connected network. This IPv6 address is usually obtained dynamically, so it may vary according to the location or new connections.

current_mncstring

Mobile Network Code of the current network to which the SIM card is connected. It's a two to three decimal digits that identify a network.<br/><br/> This code is commonly seen joined with a Mobile Country Code (MCC) in a tuple that allows identifying a carrier known as PLMN (Public Land Mobile Network) code.

current_mccstring

Mobile Country Code of the current network to which the SIM card is connected. It's a three decimal digit that identifies a country.<br/><br/> This code is commonly seen joined with a Mobile Network Code (MNC) in a tuple that allows identifying a carrier known as PLMN (Public Land Mobile Network) code.

live_data_session'connected' | 'disconnected' | 'unknown'

Indicates whether the device is actively connected to a network and able to run data.

esim_installation_status'released' | 'disabled' nullable

The installation status of the eSIM. Only applicable for eSIM cards.

versionstring

The version of the SIM card.

resources_with_in_progress_actionsobject[]

List of resources with actions in progress.

eidstring nullable

The Embedded Identity Document (eID) for eSIM cards.

voice_enabledboolean

Indicates whether voice services are enabled for the SIM card.

Example request

{
  "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
  "record_type": "sim_card",
  "status": {
    "value": "enabled",
    "reason": "The SIM card is active, ready to connect to networks and consume data."
  },
  "type": "physical",
  "iccid": "89310410106543789301",
  "imsi": "081932214823362973",
  "msisdn": "+13109976224",
  "sim_card_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
  "tags": [
    "personal",
    "customers",
    "active-customers"
  ],
  "authorized_imeis": [
    "106516771852751",
    "534051870479563",
    "508821468377961"
  ],
  "current_imei": "457032284023794",
  "data_limit": {
    "amount": "2048.1",
    "unit": "MB"
  },
  "current_billing_period_consumed_data": {
    "amount": "2049.0",
    "unit": "MB"
  },
  "actions_in_progress": true,
  "created_at": "2018-02-02T22:25:27.521Z",
  "updated_at": "2018-02-02T22:25:27.521Z",
  "ipv4": "192.168.0.0",
  "ipv6": "2001:cdba:0000:0000:0000:0000:3257:9652",
  "current_device_location": {
    "latitude": "41.143",
    "longitude": "-8.605",
    "accuracy": 1250,
    "accuracy_unit": "m"
  },
  "current_mnc": "260",
  "current_mcc": "410",
  "live_data_session": "connected",
  "pin_puk_codes": {
    "pin1": "1234",
    "pin2": "5678",
    "puk1": "12345678",
    "puk2": "87654321"
  },
  "esim_installation_status": "released",
  "version": "4.3",
  "resources_with_in_progress_actions": []
}

Response

Successful response

Example response

{
  "data": {
    "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "record_type": "sim_card",
    "status": {
      "value": "enabled",
      "reason": "The SIM card is active, ready to connect to networks and consume data."
    },
    "type": "physical",
    "iccid": "89310410106543789301",
    "imsi": "081932214823362973",
    "msisdn": "+13109976224",
    "sim_card_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "tags": [
      "personal",
      "customers",
      "active-customers"
    ],
    "authorized_imeis": [
      "106516771852751",
      "534051870479563",
      "508821468377961"
    ],
    "current_imei": "457032284023794",
    "data_limit": {
      "amount": "2048.1",
      "unit": "MB"
    },
    "current_billing_period_consumed_data": {
      "amount": "2049.0",
      "unit": "MB"
    },
    "actions_in_progress": true,
    "created_at": "2018-02-02T22:25:27.521Z",
    "updated_at": "2018-02-02T22:25:27.521Z",
    "ipv4": "192.168.0.0",
    "ipv6": "2001:cdba:0000:0000:0000:0000:3257:9652",
    "current_device_location": {
      "latitude": "41.143",
      "longitude": "-8.605",
      "accuracy": 1250,
      "accuracy_unit": "m"
    },
    "current_mnc": "260",
    "current_mcc": "410",
    "live_data_session": "connected",
    "pin_puk_codes": {
      "pin1": "1234",
      "pin2": "5678",
      "puk1": "12345678",
      "puk2": "87654321"
    },
    "esim_installation_status": "released",
    "version": "4.3",
    "resources_with_in_progress_actions": []
  }
}