Update a SIM

put

https://api.edgeiq.io/api/v1/platform/sims/{id}

Updates an existing SIM record identified by its system ID. The request body is merged onto the stored record (JSON merge). Read-only server fields (company_id, usage counters, flags, audit timestamps) are ignored if present in the request body. iccid changes must still pass uniqueness validation.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The 24-character system ID of the SIM to update.

Body Params

Request body for creating or updating a SIM. Maps directly to the backend's SimInput struct. Read-only server-managed fields (ctd_data_usage, ctd_sms_usage, included_usage, overage_limit_reached, sim_barred, last_sync_at, and audit fields) are not accepted and will be ignored if present.

device_id

string

required

The ID of the device this SIM is linked to. Required on creation.

integration_id

string

The ID of the MNO integration used to sync this SIM with a carrier connectivity management platform (CMP).

iccid

string

required

length between 18 and 22

Integrated Circuit Card Identifier. Must be 18-22 digits (ITU-T E.118). Globally unique across the platform. Required on creation.

msisdn

string

length ≤ 20

Mobile Subscriber ISDN Number (the SIM's phone number). Maximum 20 characters.

sim_status

string

length ≤ 30

SIM lifecycle status. This is an open string set by the carrier/Service Provider (CMP) sync and is NOT restricted to a fixed enum — any carrier status string is valid. Maximum 30 characters. Common values: inactive, active, suspended, deactivated, retired. Defaults to 'inactive' when omitted on creation.

communication_plan

string

length ≤ 255

Carrier communication plan name. Maximum 255 characters.

rate_plan

string

length ≤ 255

Carrier rate plan name. Maximum 255 characters.

sim_metadata

object

Extensible JSON object for carrier-specific fields. Values may be nested objects or numeric types. Maximum 50 top-level keys.

Responses

200

Successful operation

400

The request was malformed or contained invalid parameters.

401

You are not authorized

404

The item you were looking for does not exist

500

An unexpected error was encountered.

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here!