Loading...

Knowledge Base

How to Unsuspend an Order Using the API

When your system or integration needs to reactivate a suspended service automatically. This article explains how to unsuspend an order using the API. 


Description
 

Removes the Suspension 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 for which the Suspension is to be removed
 

HTTP Method
 

POST
 

Example Test URL Request
 

https://test.httpapi.com/api/orders/unsuspend.json?auth-userid=0&api-key=key&order-id=0
 

Response
 

Returns a hash map containing the below details:
  • Domain Name (description)
  • Order ID of the Domain Registration Order (entityid)
  • Action Type (actiontype)
  • Description of the Order Unsuspension Action (actiontypedesc)
  • Action ID of the Order Unsuspension Action (eaqid)
  • Order Unsuspension Action Status (actionstatus)
  • Description of the Order Unsuspension Action Status (actionstatusdesc)
In case of any errors, a status key with value as ERROR alongwith an error message will be returned.