Portfolio Manager

Sell Domains

Offers Received

Registrar

Consolidate

Verified Stats

Monetization API

Registrar API

My Account Manual

API Queries - Delete Domains

The delete_domains function removes domains from your Monetization 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 removed from your account, comma separated (up to 1,000 per query - see note below). (Required)

Note: For larger queries (when removing 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 delete the domains abc123.com, efg456.com and lmn789.net (domains=abc123.com,efg456.com,lmn789.net).

Note: This function will return the status "Success", even if the domains have already been deleted. Also note that domains are not completely removed from your account, they are moved to the "(Trash)" folder.

Example query:

https://www.above.com/api.php?username=user&password=pass&api_key=key&mode=delete_domains&domains=
abc123.com,efg456.com,lmn789.net

Response:

			<results status="Success" />
			<info>
			<result message="3 domains deleted" />
			</info>
			

Note: If the domains have already been deleted from your account (they are in the "(Trash)" folder, you will not receive an error. This will be the response:
			<results status="Success" />
			<info>
			<result message="3 domains are already deleted" />
			</info>
			

Note: If the domains specified do not exist in your account, you will not receive an error. This will be the response:
			<results status="Success" />
			<info/>
			

If many domains are being deleted and the task takes longer than 30 seconds a jobid will be provided. See the example below:

Example query:
https://www.above.com/api.php?username=user&password=pass&api_key=key&mode=delete_domains&domains=domain515.com,
domain032.com,domain041.com,
+ many more domains

Response:

			<results>
			<result jobid="12345" status="Processing"/>
			</results>
			

You can then view the progress using the jobid with the Job Status function.


Error Responses:

Possible error responses for this function are:

For a complete list of error responses, see the Error Codes manual page.