Set Group

5 min

Purpose

Moves the SIM into the specified group.

The group must be provided using the group code, not the group name. Group codes are distributor-specific and are supplied separately.

Operational Impact

API commands perform live configuration changes.

Changes take effect immediately.

Commands may affect SIM status, service availability, charging, or usage limits.

Requests cannot be undone automatically.

Ensure all parameters are validated before submitting requests to the production environment.

Endpoint

POST https://api.m2miportal.com
Content-Type: application/xml
Accept: application/xml

Request (XML)

<set-group version="1" api-id="123456">
  <authentication>
    <username>username</username>
    <password>password</password>
  </authentication>
  <iccid>1234567890123456789</iccid>
  <group>group-code</group>
</set-group>

Response (Success)

<set-group-response api-id="123456">
  <api-outcome>Success</api-outcome>
</set-group-response>

Response (Failure)

If a request cannot be processed, the response will include:

api-outcome indicating failure

An error description explaining the reason

Failure responses may occur due to:

Invalid authentication credentials

Invalid or unknown identifiers (for example ICCID or MSISDN)

Invalid or missing parameters

Values not permitted for the specified SIM type or account configuration

Insufficient permissions

Integrating systems should validate input data before submission and implement appropriate error handling and logging.