Difference between revisions of "Update Customer Name"

Latest revision as of 12:48, 14 November 2016

[edit] Summary

The Update Customer Name API call allows an existing customer to be updated with a new name by giving the existing name of a customer, along with the new name. A customer name can be updated via two different methods - either as multi-part form data with the 3 parameters, or as JSNO content on its own, with the API key supplied within the JSON.

[edit] Multi Part Form Data

[edit] JSON As Body

[edit] JSON Contents

[edit] Example Input

[edit] JSON As Body

{
   "key":"your_api_key",
   "existing_customer_name":"oldName123",
   "new_customer_name":"newName456"
}

[edit] Example Curl Request

[edit] Multi Part Form Data

curl -F api_key=YOUR_KEY -F existing_name=CUSTOMER_EXISTING_NAME -F new_name=CUSTOMER_NEW_NAME http://api.mymobileworkers.com:8080/api/1/companies/company/customers/updatename

[edit] JSON As Body

curl -X POST -H "Content-Type: application/json" -d '{"key":"YOUR_KEY", "existing_customer_name":"OLDNAME", "new_customer_name":"NEWNAME"}' http://api.mymobileworkers.com:8080/api/1/companies/company/customers/updatename

[edit] Responses

[edit] Successful

{"result":"success","existing_customer_name":"testName24","new_customer_name":"darrenTest24"}

[edit] Unsuccessful

{"error_code":"CUS002","error_message":"Customer cannot be found"}
{"error_code":"CUS011","error_message":"Customer name not provided. Please specify customer name in the request."}
{"result":"failed","existing_customer_name":"testName24","new_customer_name":"darrenTest24"}