POST /Japi/Tigrillo/suspendSIMs
Suspends multiple SIMs. The current SIM state must allow suspension – you cannot suspend a SIM that is already suspended, pending termination, or terminated.
Suspension starts immediately, but the SIM will initially deprovision. The suspension process takes up to two hours until the status displays as suspended. You cannot use the SIM card in its suspended state.
When suspended, the SIM will continue to connect to the network, and service charges will continue. However, usage charges will not continue. For more information, see Understanding service charges.
If required, you can reverse the suspension and reactivate the SIM card. For more information, see POST /Japi/Tigrillo/unsuspendSIMs.
Authentication
- User required to login
Headers
For information about headers, see Configuring headers.
Request Body application/json
Schema
Object name | Description | Required? |
---|---|---|
sims |
The array, listing the SIM cards you want to suspend. |
![]() |
ICCID | The ICCID of a SIM you want to suspend. |
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. For more information, see Troubleshooting errors: Tigrillo API. |
errorMessage |
"" – the request processed successfully "<ErrorCodeMessage>" – displays an explanation of the error if the request failed. For more information, see Troubleshooting errors: Tigrillo API. |
simStatuses | The simStatuses title, which includes the ICCID. If all SIMs are successfully suspended, this section does not appear in the returned results. |
"<ICCID>": errorMessage | The ICCID of each SIM that was not suspended, with a reason for the error. |
Example
{
"status": {
"status": "OK",
"errorCode": "",
"errorMessage": ""
},
"simStatuses": {
"8944538523013777333": "E0137:Invalid SIM no. provided",
}
}