reseller

is added when reseller has a customer specific business

Deleting TXT Record

Description

Deletes a Text (TXT) record.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
domain-name String Required Domain name for which you want to delete a TXT record
host String Required Hostname of the record to be deleted
value String Required A text value for which the record to be deleted

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/dns/manage/delete-txt-record.json?auth-userid=0&api-key=key&domain-name=domain.com&host=@&value=text-value

Response

Returns Success as the status of the response if the record is deleted successfully or record does not exist.

In case of any error, an error key with error description (as value) will be returned.

Deleting NS record

Description

Deletes a Name Server (NS) record.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
domain-name String Required Domain name for which you want to delete a NS record
host String Required Hostname of the record to be deleted
value String Required A Fully Qualified Domain Name (FQDN)

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/dns/manage/delete-ns-record.json?auth-userid=0&api-key=key&domain-name=domain.com&host=@&value=ns1.domain.com

Response

Returns Success as the status of the response if the record is deleted successfully or record does not exist.

In case of any error, an error key with error description (as value) will be returned.

Deleting MX record

Description

Deletes a Mail Exchanger (MX) record.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
domain-name String Required Domain name for which you want to delete a MX record
host String Required Hostname of the record to be deleted
value String Required A Fully Qualified Domain Name (FQDN)

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/dns/manage/delete-mx-record.json?auth-userid=0&api-key=key&domain-name=domain.com&host=@&value=mx1.domain.com

Response

Returns Success as the status of the response if the record is deleted successfully or record does not exist.

In case of any error, an error key with error description (as value) will be returned.

Deleting CNAME record

Description

Deletes a Canonical (CNAME) record.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
domain-name String Required Domain name for which you want to delete a CNAME record
host String Required Hostname of the record to be deleted
value String Required A Fully Qualified Domain Name (FQDN)

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/dns/manage/delete-cname-record.json?auth-userid=0&api-key=key&domain-name=domain.com&host=webmail&value=webmail.domain.com

Response

Returns Success as the status of the response if the record is deleted successfully or record does not exist.

In case of any error, an error key with error description (as value) will be returned.

Deleting IPv6 Address Record

Description

Deletes an IPv6 Address (AAAA) record.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
domain-name String Required Domain name for which you want to delete an IPv6 record
host String Required Hostname of the record to be deleted
value String Required An IPv6 address to be deleted

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/dns/manage/delete-ipv6-record.json?auth-userid=0&api-key=key&domain-name=domain.com&host=www&value=0.0.0.0

Response

Returns Success as the status of the response if the record is deleted successfully or record does not exist.

In case of any error, an error key with error description (as value) will be returned.

Deleting IPv4 Address Record

Description

Deletes an IPv4 Address (A) record.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
domain-name String Required Domain name for which you want to delete an IPv4 record
value String Required An IPv4 address to be deleted
host String Optional Hostname of the record to be deleted. By default, IP address gets deleted for the domain name.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/dns/manage/delete-ipv4-record.json?auth-userid=0&api-key=key&domain-name=domain.com&host=www&value=0.0.0.0

Response

Returns Success as the status of the response if the record is deleted successfully or record does not exist.

In case of any error, an error key with error description (as value) will be returned.

Modifying SOA Record

Description

Modifies a Start of Authority (SOA) record.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
domain-name String Required Domain name for which you want to modify a SOA record
responsible-person String Required The email address of the person responsible for maintenance of the Zone
refresh Integer Required The number of seconds after which the Secondary DNS Server checks the Primary DNS Server to check if the Zone has changed. Value should not be less than 7200, i.e., 2 hours.
retry Integer Required Number of seconds that should elapse before a failed refresh should be retried. Value should not be less than 7200, i.e., 2 hours.
expire Integer Required Number of seconds that specifies the upper limit on the time interval that can elapse before the zone is no longer authoritative. Value should not be less than 172800, i.e., 48 hours.
ttl Integer Required Number of seconds the record needs to be cached by the DNS Resolvers. Value should not be less than 14400, i.e., 4 hours.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/dns/manage/update-soa-record.json?auth-userid=0&api-key=key&domain-name=domain.com&responsible-person=admin@domain.com&refresh=7200&retry=7200&expire=172800&ttl=14400

Response

Returns Success as the status of the response if the record is modified successfully.

In case of any error, an error key with error description (as value) will be returned.

Adding a Miscellaneous Invoice in a Sub-Reseller Account

Description

Adds a miscellaneous Invoice against the specified Sub-Reseller's Account.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required Order Id of Order against which Invoice to be added
reseller-id Integer Required Reseller Id of Sub-Reseller against whom Invoice to be added
selling-amount Float Required Amount of Invoice in the Selling Currency of Parent Reseller
description String Required Description for Invoice
invoice-date Integer Required Date in epoch time format on which Invoice to be added
invoice-due-date Integer Optional Date in epoch time format on which Invoice due date to be set
invoice-deletion-date Integer Optional Date in epoch time format on which Invoice deletion date to be set
transaction-key String Required Unique Transaction key
accounting-amount Float Optional Amount of Invoice in the Accounting Currency of the Parent Reseller. Required if Selling and Accounting Currencies of the Parent Reseller are different.
conversion-rate Float Optional Conversion rate between Selling and Accounting amounts. Required if Selling and Accounting Currencies of the Parent Reseller are different.
payment-reminder-days Integer Optional No of days in which Reseller needs to be reminded about Invoice
greedy Boolean Optional Possible values are true or false. Pass true if you want Invoice to be Greedy.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/billing/add-reseller-misc-invoice.json?auth-userid=0&api-key=key&order-id=0&reseller-id=0&selling-amount=0.0&description=description-text&invoice-date=0000000000&transaction-key=transaction-key-text

Response

Returns a Transaction Id (Integer) if the Invoice is added successfully against the specified Sub-Reseller's Account.

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

Adding a Miscellaneous Invoice in a Customer Account

Description

Adds a miscellaneous Invoice against the specified Customer's Account.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required Order Id of Order against which Invoice is to be added
customer-id Integer Required Customer Id of Customer against whom Invoice is to be added
selling-amount Float Required Amount of Invoice in the Selling Currency of the Parent Reseller
description String Required Description of the Invoice
invoice-date Integer Required Date in epoch time format on which Invoice is to be added
invoice-due-date Integer Optional Date in epoch time format on which Invoice due date is to be set
invoice-deletion-date Integer Optional Date in epoch time format on which Invoice deletion date is to be set
transaction-key String Required Unique Transaction key
accounting-amount Float Optional Amount of Invoice in the Accounting Currency of the Parent Reseller. Required if Selling and Accounting Currencies of the Parent Reseller are different.
conversion-rate Float Optional Conversion rate between Selling and Accounting amounts. Required if Selling and Accounting Currencies of the Parent Reseller are different.
payment-reminder-days Integer Optional No of days in which Customer needs to be reminded about Invoice
greedy Boolean Optional Possible values are true or false. Pass true if you want the Invoice to be Greedy.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/billing/add-customer-misc-invoice.json?auth-userid=0&api-key=key&order-id=0&customer-id=0&selling-amount=0.0&description=description-text&invoice-date=0000000000&transaction-key=transaction-key-text

Response

Returns a Transaction Id (Integer) if the Invoice is added successfully against the specified Customer's Account.

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

Adding a Debit Note in a Sub-Reseller Account

Description

Adds a Debit Note against the specified Sub-Reseller's Account.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
reseller-id Integer Required Reseller Id of Reseller against whom Debit Note is to be added
selling-amount Float Required Amount of Debit Note in the Selling Currency of the Parent Reseller
description String Required Description for the Debit Note
debit-note-date Integer Required Date in epoch time format on which Debit Note is to be added
transaction-key String Required Unique Transaction key
update-total-receipt Boolean Required Possible values are true or false. Pass true if you want to update total receipt of Sub-Reseller.
accounting-amount Float Optional Amount of Debit Note in the Accounting Currency of the Parent Reseller. Required if Selling and Accounting Currencies of the Parent Reseller are different.
conversion-rate Float Optional Conversion rate between selling and accounting amounts. Required if Selling and Accounting Currencies of the Parent Reseller are different.
payment-reminder-days Integer Optional No of days in which Reseller needs to be reminded about Debit Note
greedy Boolean Optional Possible values are true or false. Pass true if you want Debit Note to be Greedy.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/billing/add-reseller-debit-note.json?auth-userid=0&api-key=key&reseller-id=0&selling-amount=0.0&description=description-text&debit-note-date=0000000000&transaction-key=transaction-key-text&update-total-receipt=true

Response

Returns a Transaction Id (Integer) if the Debit Note is added successfully against the specified Sub-Reseller's Account.

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