Solar Proof API Documentation - Update Customer

 

 

API > Customers > Update Customer

POST https://solarproof.com.au?api_key=17eca4408560ac218adef09fa710647ccde4&action=updatecustomer

Update customer.

Parameters
data (JSON Object) A JSON object containing the following keys:
  • apikey (string): Your API key.
  • action (string): "updatecustomer"
  • pkcustomerid (integer): 79461
  • firstname (string): The first name of the customer.
  • surname (string): The surname of the customer.
  • email (string): The email of the customer.
  • phone1 (string): The primary phone number for the customer.
  • phone2 (string): The secondary phone number for the customer.
  • companyname (string): The company name for the customer's business (if any).
  • companyphone (string): The phone number for the customer's company.
  • type (string): The type of customer - either 'Commercial' or 'Residential'.
  • gststatus (integer): GST status of the customer (e.g., 1 for active).
200 (Success) Returns
Message (string) { "Message": "Customer updated successfully!", "id": "79459" }
Non-200 (Error) Returns

Details of the error:

code (string) The error code.
message (string) A description of the error.
Example Request 

{
    "data": {
        "apikey": "17eca4408560ac218adef09fa710647ccde4",
        "action": "updatecustomer",
        "pkcustomerid": "79461",
        "firstname": "Jems",
        "surname": "B",
        "phone1": "9595057009",
        "phone2": "9595087009",
        "email": "Jems@example.com",
        "gststatus": 1,
        "companyname": "Jems LLP ",
        "companyphone": "9595059595",
        "type": "RESIDENTIAL",
    }
}
Example Response 
{
    "Message": "Customer updated successfully!",
    "CustomerId": "79461"
}
Book Demo