Lock

Description

Applies a Lock on the specified Order.

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 the Order on which the lock is to be applied
reason String Required The reason for the lock.

HTTP Method

POST

Example Test URL Request

https://httpapi.com/api/domains/reseller-lock/add.json?auth-userid=0&api-key=key&order-id=0&reason=reason-for-lock

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order ID of the Order to be locked (entityid)

  • Action Type (actiontype)

  • Description of the Order lock Action (actiontypedesc)

  • Action ID of the Order lock Action (eaqid)

  • Order lock Action Status (actionstatus)

  • Description of the Order lock Action Status (actionstatusdesc)

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