Description
Creates a Customer Account using the details provided.
Parameters
Name | Data Type | Required / Optional | Description |
---|---|---|---|
auth-userid | Integer | Required | Authentication Parameter |
api-key | String | Required | Authentication Parameter |
username | String | Required | Username for the Customer Account. Username should be an email address. |
passwd | String | Required |
Password for the Customer Account. |
name | String | Required | Name of the Customer |
company | String | Required | Name of the Customer's company |
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 | Telephone 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 |
sms-consent | Boolean | Optional | In case of a US based customer, consent is required to receive renewal reminder SMSes |
vat-id | String | Optional | VAT ID for EU VAT |
accept-policy | Boolean | Optional | Accept Terms and Conditions and Privacy Policy to create an account |
marketing-email-consent | Boolean | Optional | In case of EEA (European Economic Area) countries capture consent to receive marketing emails |
HTTP Method
POST
Example Test URL Request
https://test.httpapi.com/api/customers/v2/signup.xml?auth-userid=0&api-key=key&username=email@email.com&passwd=password9&name=name &company=company&address-line-1=address-line-1&city=city&state=state&country=US&zipcode=0000&phone-cc=0&phone=000000&lang-pref=en
Response
Creates a Customer Account and returns the Customer ID (Integer) of the newly added Customer.
In case of any errors, a status key with value as ERROR alongwith an error message will be returned.