API Queries - Update Domains
The update_domains function updates domains to your Above.com Parking Manger account (up to 1,000 at a time - see note below). Additional parameters are required for this function.
Additional Parameters
- domains - The domain or domains to be updated to your account, comma separated (up to 1,000 per query - see note below). (Required)
- folder - Name of the folder to update domains to. If omitted, the default folder will be used. If the folder does not exist, an error will be returned. (Optional)
- flag - Type of domain. Only these values are allowed ['Generic','Typo','Risk','Traffic','Content','Junk','BlackListed','C&D','Sell','Others'] (Optional)
- paid - Amount paid for the domain. (Optional)
- acquired_date - Date of domain acquired. (YYYY-MM-DD) format (Optional)
- reserve - Reserve price for domain, should be equal to or less than min offer amount & bin. (Optional)
- min - MinOffer amount of domain, should be equal to or more than bin amount & reserve. (Optional)
- bin - Buy It Now amount of domain, should be equal to or more than min offer amount & reserve. (Optional)
- adult - Y/N. (Optional)
- forsale - Y/N. (Optional)
Note: If domain does not exist in your account already, it will be added in default folder if folder is not mentioned and if other folder name is mentioned instead of the actual folder in which the domain is, the domain will move to the latest folder mentioned.
Note: For larger queries (when adding more than 100 domains at a time), you MUST use a POST request to ensure you do not reach any request length limitations.
Note: Make sure to URL encode all values.
Example query and response:
In this example, we will update the reserve, min and bin for the domain domainlive1.icu
Note: This function will return the status "Success"
Example query:
https://www.above.com/api.php?username=user&api_key=key&mode=update_domains&domains=testdomain.com&reserve=200&min=200&
bin=200
Response:
<results status="Success" /> <result message="1 domain is in the current folder" /> <detail> <updated> <result Domain="testdomain.com" BIN="BIN 200 updated successfully" MinOffer="MinOffer 200 updated successfully" Reserve="Reserve 200 updated successfully" /> </updated> </detail> </result> </results>
Note: If domain does not exits, it will be added in the current folder or else the default folder. See the example below:
Example query:
https://www.above.com/api.php?username=user&api_key=key&mode=update_domains&domains=testdomain.com&reserve=200&min=200&
bin=200
Response:
<results status="Success" /> <result message="1 new domain added" /> <detail> <updated> <result Domain="testdomain.com" BIN="BIN 200 cannot be less than Reserve amount or less than MinOffer amount" MinOffer="MinOffer 200 cannot be less than Reserve amount or less than BIN amount" Reserve="Reserve 200 cannot be less than BIN amount or less than MinOffer amount" /> </updated> </detail> </result> </results>
Error Responses:
Possible error responses for this function are:
- 410 - No domain or domains parameter passed
- 413 - Folder Not Found
- 500 - Job failed. Please contact support if problems persist.
- General errors, such as 200 - Internal Error or 300 - Username invalid.