Edit Customer

5 min

Purpose

Adds or amends data in an existing customer record on your account.

The customer is identified using the <customer> element. This must exactly match a customer that already exists on your account, either created via the Insight Portal or using the Add Customer operation.

If a customer name is supplied that does not exist on your account, the API will return an Invalid Content response.

All other elements are optional:

Elements that are not specified will remain unchanged

Elements that are included but empty will cause any existing content to be deleted

Field length limits apply:

<website>: maximum 100 characters

<head-office>: maximum 200 characters

<delivery-address>: maximum 200 characters

<billing-address>: maximum 200 characters

<notes>: maximum 500 characters

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)

<edit-customer version="1" api-id="123456">
  <authentication>
    <username>username</username>
    <password>password</password>
  </authentication>
  <customer>Global Trading</customer>
  <website>www.gbtrading.com</website>
  <head-office>GBT House, Tech Avenue, Webberley, London, UK, TH77 3GG</head-office>
  <delivery-address>GBT Central Stores, Liverpool Road, St Helens, Merseyside, L39 3JP</delivery-address>
  <billing-address>As Head Office</billing-address>
  <notes>New Account, Initial trial, Manager PGT</notes>
</edit-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.