Add Customer

5 min

Purpose

Customers can be assigned to SIMs to support reporting and to provide user access limited to SIMs belonging to a specific customer.

The new customer name is specified using the <customer> element.

<customer> must be a unique string within your account

Maximum length: 50 characters

Empty values or names that already exist on your account will return an Invalid Content response

Data must be entered as plain text. Reserved XML characters must be escaped as described in the XML format section.

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)

<add-customer version="1" api-id="123456">
  <authentication>
    <username>username</username>
    <password>password</password>
  </authentication>
  <customer>Global Trading</customer>
</add-customer>

Response (Success)

<add-customer-response api-id="123456">
  <api-outcome>Success</api-outcome>
</add-customer-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.