POST /Japi/Tigrillo/setSIMState
Changes the state of a single SIM to either of the following states:
- suspended – displayed when you suspend a SIM using this method
- available – displayed when you terminate a SIM using this method. The SIM will cycle through pendingDeprovision > unprovisioned > available. If the SIM is pendingDeprovision, you cannot change its state.
If you want to set the state of multiple SIMs, use any of the following methods:
- activateSIMs – see POST /Japi/Tigrillo/activateSIMs.
- suspendSIMs – see POST /Japi/Tigrillo/suspendSIMs.
- unsuspendSIMs – see POST /Japi/Tigrillo/unsuspendSIMs.
- terminateSIMs – see POST /Japi/Tigrillo/terminateSIMs.
Authentication
- User required to login
Headers
For information about headers, see Configuring headers.
Request Body application/json
Schema
Object name | Description | Required? |
---|---|---|
ICCID | The current SIM ICCID |
![]() |
state | The desired state, either "suspend", or "terminate". |
Example
Responses application/json
Schema
JSON key | Description |
---|---|
status |
The array, containing details about the request status. |
status |
"OK" – the request processed successfully "ERR" – the request failed |
errorCode |
"" – the request processed successfully "<ErrorCodeNumber>" – the request failed because of this specific error. |
errorMessage |
"" – the request processed successfully "<ErrorCodeMessage>" – displays an explanation of the error if the request failed. |