Commands
The Commands section documents API operations that perform changes to SIM configuration or operational state.
Commands are used to execute actions that would otherwise be performed manually through the Portal.
Because commands modify system state, they may have immediate operational and commercial impact.
What Is a Command?
A command is an authenticated API request that:
- Changes SIM configuration
- Updates operational settings
- Modifies group assignment
- Alters usage thresholds
- Performs other management actions
Commands are write operations.
Operational Impact
Many commands:
- Take effect immediately
- Change SIM behaviour
- Affect charging status
- Modify access to network services
Integrating systems must validate input data carefully before issuing commands.
It is recommended that:
- Safeguards are implemented
- Commands are logged
- Production usage is controlled
Batch Processing
Where supported, commands may apply to:
- A single SIM
- Multiple SIMs in one request
The specific behaviour and limits are defined in each command reference.
Command Reference Structure
Each command reference page includes:
- Purpose
- Required parameters
- Request structure
- Response structure
- Example payload
- Notes and operational considerations
Commands are listed individually in the pages that follow.
Available Commands
The following commands are documented in this section:
- Set Group
- Set Status
- Add Nominal Credit
- Set Custom Data
- Add Customer
- Edit Customer
- Set Auto-Activation Group
- Set Usage Levels
- Cancel Location
- Set QR Status