POST /Japi/Tigrillo/setSIMDetail

Updates the details of a single SIM.

Authentication

  • User required to login

Headers

For information about headers, see Configuring headers.

Request Body application/json

Schema

Object name Description Required?
ICCID The unique Integrated Circuit Card Identifier of the SIM you want to update.
friendlyName

A unique user-friendly name, to help identify the SIM. Change this value in the SIAM portal. Friendly names contain up to 255 characters and should not include commas.

  
group

The SIM group name. Set the group names for SIM collections when you activate them using POST /Japi/Tigrillo/activateSIMs, or through the SIAM portal. The default is null.

  

Example

Copy
Body raw JSON
{
"ICCID" : "8944538523012555999" ,
"friendlyName" : "Warehouse1 Hera604",
"group" : null
}

Use null without quotes as the input if you do not wish to use these objects. The value will remain as previously set. If you want to change the object value to a new value, replace null with "<value>" within quotes, where <value> is the required value. To remove an existing value, type an empty string. For example: "friendlyName" : "" ,

Responses application/json

Schema

Object name 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.

Example

Copy
JSON
{
    "status": {
        "status": "OK",
        "errorCode": "",
        "errorMessage": ""
    }
}

Where to next?

Related resources