Update a specific SIM

Updates a SIM. Send only the fields you want to change.

Do not send null or an empty string. Any iccMnoId, iccSpecId, or iccTypeId you send must already exist in the system.

You cannot change a suspended SIM. Unsuspend it first.

patch

Authorizations

AuthorizationstringRequired

An OAuth 2.0 client credentials access token, sent as Authorization: Bearer <token>.

Request the token from https://eseye-idp-prod.auth.eu-west-1.amazoncognito.com/oauth2/token using the client ID and client secret Eseye supplied. Tokens expire after one hour.

Path parameters

iccIdstringRequired

The ICC ID of the SIM.

Example: 8944500000000000123

Body

iccMnoIdstringOptional

The mobile network operator the SIM belongs to.

Example: 12345

iccSpecIdstringOptional

The specification the SIM was manufactured to.

Example: 12345

iccTypeIdstringOptional

The type of SIM.

Example: 123

adminSuspendstring · enumOptional

A yes or no flag.

Value	Meaning
`yes`	The service or object is disabled.
`no`	The service or object is not disabled.

Example: noPossible values:

systemSuspendstring · enumOptional

A yes or no flag.

Value	Meaning
`yes`	The service or object is disabled.
`no`	The service or object is not disabled.

Example: noPossible values:

customerSuspendstring · enumOptional

A yes or no flag.

Value	Meaning
`yes`	The service or object is disabled.
`no`	The service or object is not disabled.

Example: noPossible values:

voiceSuspendstring · enumOptional

A yes or no flag.

Value	Meaning
`yes`	The service or object is disabled.
`no`	The service or object is not disabled.

Example: noPossible values:

dataSuspendstring · enumOptional

A yes or no flag.

Value	Meaning
`yes`	The service or object is disabled.
`no`	The service or object is not disabled.

Example: noPossible values:

messagingSuspendstring · enumOptional

A yes or no flag.

Value	Meaning
`yes`	The service or object is disabled.
`no`	The service or object is not disabled.

Example: noPossible values:

pin1stringOptional

The first PIN for the SIM.

pin2stringOptional

The second PIN for the SIM.

puk1stringOptional

The first PUK code for the SIM.

puk2stringOptional

The second PUK code for the SIM.

eIdstringOptional

The eUICC identifier of the SIM.

Example: 12345

platformIdstringOptional

The platform the SIM is provisioned on.

activatedDatestringOptional

The date the SIM was activated.

terminatedDatestringOptional

The date the SIM was terminated.

statusstring · enumOptional

The status of the SIM.

Value	Meaning
`available`	The SIM exists on your account and has a package, but cannot connect to a network. No service charges apply.
`active`	The SIM is provisioned and ready to use on the network. Standard service charges and usage charges apply.

Set status to active to activate a SIM, or to available to deactivate it.

Example: activePossible values:

rspIdstringOptional

The remote SIM provisioning platform the SIM uses.

Example: 78901

Responses

200

The updated SIM.

application/json

A SIM on your account, identified by its ICC ID.

iccIdstring · max: 20Optional

The Integrated Circuit Card Identifier that uniquely identifies the SIM, or the eUICC SIM profile.

Example: 8944500000000000123

simIdstring · max: 32Optional

The Eseye SIM reference number, printed on the physical SIM card.

Example: 9445000000000123

iccMnoIdstringOptional

Identifies the mobile network operator that provides the IMSI.

Example: 9953

iccSpecIdintegerOptional

The SIM manufacturing batch number, which identifies the SIM specification.

Example: 5215

iccTypeIdintegerOptional

The SIM part number, which identifies the form factor, such as plug-in, embedded, or eSIM.

Example: 152

adminSuspendstring · enumOptional

A yes or no flag.

Value	Meaning
`yes`	The service or object is disabled.
`no`	The service or object is not disabled.

Example: noPossible values:

systemSuspendstring · enumOptional

A yes or no flag.

Value	Meaning
`yes`	The service or object is disabled.
`no`	The service or object is not disabled.

Example: noPossible values:

customerSuspendstring · enumOptional

A yes or no flag.

Value	Meaning
`yes`	The service or object is disabled.
`no`	The service or object is not disabled.

Example: noPossible values:

dataSuspendstring · enumOptional

A yes or no flag.

Value	Meaning
`yes`	The service or object is disabled.
`no`	The service or object is not disabled.

Example: noPossible values:

messagingSuspendstring · enumOptional

A yes or no flag.

Value	Meaning
`yes`	The service or object is disabled.
`no`	The service or object is not disabled.

Example: noPossible values:

voiceSuspendstring · enumOptional

A yes or no flag.

Value	Meaning
`yes`	The service or object is disabled.
`no`	The service or object is not disabled.

Example: noPossible values:

eIdstring · max: 32Optional

The eUICC identifier. This is the global serial number that identifies an eUICC for remote SIM provisioning.

Example: 89049032000000000000000000000001

pin1string · max: 5Optional

The primary PIN, used to unlock the SIM. Eseye advises against enabling a PIN on IoT devices.

pin2string · max: 5Optional

The secondary PIN, used to unlock advanced SIM services. Eseye advises against enabling a PIN on IoT devices.

puk1string · max: 8Optional

The unblocking key that resets pin1 after too many incorrect attempts.

puk2string · max: 8Optional

The unblocking key that resets pin2 after too many incorrect attempts.

rspIdintegerOptional

Identifies the remote SIM provisioning platform the SIM uses.

Example: 78901

platformIdintegerOptional

Identifies the platform the SIM is provisioned on.

Example: 1

activatedDatestring · date-timeOptional

When the SIM was first activated. All times are UTC.

Example: 2023-06-28T05:52:03Z

terminatedDatestring · nullableOptional

When the SIM was terminated. null if the SIM has not been terminated.

statusstring · enumOptional

The status of the SIM.

Value	Meaning
`available`	The SIM exists on your account and has a package, but cannot connect to a network. No service charges apply.
`active`	The SIM is provisioned and ready to use on the network. Standard service charges and usage charges apply.

Set status to active to activate a SIM, or to available to deactivate it.

Example: activePossible values:

400

The request contained an invalid parameter. additionalDetails lists the fields that failed validation.

application/json

403

The token is valid, but the service account does not have permission for this operation.

application/json

404

An entity referenced in the request does not exist. The message and additionalDetails name what could not be resolved.

application/json

patch/api/v2/sim/{iccId}

PATCH /api/v2/sim/{iccId} HTTP/1.1
Host: sim.api.anynetiot.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "iccMnoId": "12345",
  "adminSuspend": "yes"
}

{
  "iccId": "8944500000000000123",
  "simId": "9445000000000123",
  "iccMnoId": "9953",
  "iccSpecId": 5215,
  "iccTypeId": 152,
  "adminSuspend": "yes",
  "systemSuspend": "no",
  "customerSuspend": "no",
  "dataSuspend": "no",
  "messagingSuspend": "no",
  "voiceSuspend": "no",
  "eId": "89049032000000000000000000000001",
  "pin1": null,
  "pin2": null,
  "puk1": null,
  "puk2": null,
  "platformId": 1,
  "terminatedDate": null,
  "status": "active",
  "activatedDate": "2023-09-27T11:21:14Z",
  "attributes": [
    {
      "iccAttributeId": 27076236,
      "iccId": "8944500000000000123",
      "attribute": "siteRef",
      "value": "532",
      "status": "active"
    },
    {
      "iccAttributeId": 27076229,
      "iccId": "8944500000000000123",
      "attribute": "deviceProfileId",
      "value": "3352",
      "status": "active"
    }
  ]
}

PreviousView a specific SIM

NextSIM Attribute

Last updated 5 days ago

Was this helpful?