reseller

is added when reseller has a customer specific business

Changing a Customer's Password

Description

Changes the password for 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 password needs to be changed
new-passwd String Required New password

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/customers/v2/change-password.json?auth-userid=0&api-key=key&customer-id=0&new-passwd=password1

Response

Returns true (Boolean) if the Customer's password is changed successfully.

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

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

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.

Signing Up

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.

Customers

Sign Up

Creates a Customer account.

Modify Customer Details

Modifies the details of the specified Customer.

Get Customer Details by Username

Gets the details of the specified Customer by specifying their Username (email address).

Get Customer Details by ID

Gets the details of the specified Customer by specifying their ID.

Generate Token

Authenticates Customer and returns an authentication token if user is authenticated successfully.

Authenticate Token

Authenticates token generated by the Generate Token method & returns the Customer details if authenticated.

Change Password

Changes the Customer's password.

Delete Customer

Deletes the specified Customer.

Modifying a Sub-Reseller's Profile Details

You may update your Sub-Reseller's Profile Details by following the below mentioned process:

  1. Search for the Sub-Reseller and proceed to the Sub-Reseller Details view. See details

  2. In the Sub-Reseller Details views, click the Modify button.

  3. Here, you can modify the Sub-Reseller's Profile Details.

  4. Click the Modify button to submit the changes.

Note
  • This process allows you to modify your Sub-Reseller's Email Address (Username of his Control Panel) if the existing Email Address is no
    longer in use or your Sub-Reseller has lost control over it.

  • The Personal Identification Number (PIN) of your Sub-Reseller cannot be modified.

Modifying a Customer's Profile Details

You may update your Customer's Profile Details by following the below mentioned process:

  1. Search for the Customer and proceed to the Customer Details view. See details

  2. In the Customer Details view, click the Modify button.

  3. Here, you can modify the Customer's Profile Details.

  4. Click the Modify button to submit the changes.

Note
  • This process allows you to modify your Customer's Email Address
    (Username of his Control Panel) if the existing Email Address is no
    longer in use or your Customer has lost control over it.

  • The Personal Identification Number (PIN) of your Customer cannot be modified.

Change your Personal Identification Number (PIN)

When you sign up for a Reseller Account with ,
an email containing the Account details will be sent to you. The Account details
include a numeric code known as Personal Identification Number (PIN).
The PIN will also be listed in the Reseller
Profile Details view, which can be accessed by clicking on the icon at the top right corner of the page and then
clicking on Your Account & Security within your Reseller Control Panel.
may request you to authenticate yourself through this PIN, when you request
support.

You can easily modify your Personal
Identification Number (PIN) by following the below
process:

  1. Log in to your Reseller Control Panel. See details

  2. Click on the icon at the top right corner of the page and then click on Your Account & Security.

  3. On the Account & Security page, under the Security section, click on View / Change your PIN.

  4. In the modal window click on the Change link and enter a new PIN.

      Note

      You need to consider the following, in relation with your Personal Identification Number (PIN):

      • The PIN should consist of 4 numeric characters.

      • Change the PIN on a regular basis.

      • Avoid using a PIN that contains personal information (social security number, birth date, etc.).

      • Avoid using repeating (1111) or sequential (1234) numbers.

      • Do not disclose your PIN to any unauthorized person.

  5. Click on the Change PIN button to submit your change.

Getting .COOP Sponsors associated with a Customer

Description

Gets a list of system default .COOP Sponsors (Co-operative Reference) and associated Sponsor 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 The Customer for whom you want to get the list of Sponsors

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/contacts/sponsors.json?auth-userid=0&api-key=key&customer-id=0

Response

Returns a hash map containing a list of system default .COOP Sponsors (Co-operative Reference) and associated Sponsor of the specified Customer, alongwith the below details:

  • Company (company)

  • Name (name)

  • Email Address (emailaddr)

  • Country (country)

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

Adding a .COOP Sponsor

Description

Adds a Sponsor (Co-operative Reference) for a specified Customer.

Note

You need to specify only a single Sponsor (Co-operative Reference).

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
name String Required Name of Contact
company String Required Name of the Company
email String Required Email address of the Contact
address-line-1 String Required First line of address of the Contact
city String Required Name of the City
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 Telephone number
customer-id Integer Required The Customer under whom your are creating the Sponsor
address-line-2 String Optional Second line of address of the Contact
address-line-3 String Optional Third line of address of the Contact
state String Optional Name of the State
fax-cc String Optional Fax number Country Code
fax String Optional Fax number

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/contacts/coop/add-sponsor.json?auth-userid=0&api-key=key&name=abc&company=company&email=dummy@abc.com&address-line-1=address1&city=city&country=nn&zipcode=0&phone-cc=0&phone=0&customer-id=0

Response

Returns the sponsor-id (Integer) of the newly added Sponsor. If a Sponsor exists with same Name and Company, then the existing sponsor-id is returned.