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