Modifying Customer Details

Description

Modifies the Account details of the specified Customer.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
customer-id Integer Required Customer Id of the Customer whose details need to be modified
username String Required Username for the Customer account. Username should be an email address.
name String Required Name of the Customer
company String Required Company name of the Customer
address-line-1 String Required Address line 1 of the Customer's address
city String Required City
state String Required State. In case the State information is not available, you need to pass the value for this parameter as Not Applicable.
other-state String Optional

This parameter needs to be included if the State information is not available.

Mention an appropriate value for this parameter.

country String Required Country Code as per ISO 3166-1 alpha-2
zipcode String Required ZIP code
phone-cc String Required Phone number Country Code
phone String Required Phone number
lang-pref String Required Language Code as per ISO
address-line-2 String Optional Address line 2 of the customer's address
address-line-3 String Optional Address line 3 of the Customer's address
alt-phone-cc String Optional Alternate phone Country Code
alt-phone String Optional Alternate phone number
fax-cc String Optional Fax number Country Code
fax String Optional Fax number
mobile-cc String Optional Mobile country code
mobile String Optional Mobile number
vat-id String Optional VAT ID for EU VAT
indian-gst-id String Optional GST ID for Indian customer
russia-vat-id String Optional VAT ID for Russian customer
australia-gst-id String Optional GST ID for Australia customer
newzealand-gst-id String Optional GST ID for New Zealand customer
singapore-gst-id String Optional GST ID for Singapore customer

HTTP Method

POST

Example Test URL Request

https://test.httpapi.com/api/customers/modify.json?auth-userid=0&api-key=key&customer-id=0&username=email@email.com&name=name&company=company&lang-pref=en&address-line-1=address-line-1&city=city&state=state&country=US&zipcode=0000&phone-cc=0&phone=000000

Response

Returns true (Boolean) if the Customer's Account details are modified successfully.

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.