API Queries - Delete Folder

The delete_folder function removes a folder. This function does not delete domains from the specified folder - instead they are moved to the "(Default)" folder. Additional parameters are required for this function.

Additional Parameters

• folder - Name of the folder you want to delete. (Required)

Note: Make sure to URL encode all values.

Example query and response:

In this example we will delete the folder "parked domains1" (folder=parked%20domains1) that has hundreds of domains in it. As this job will take longer than 30 seconds, a jobid will be given.

Note: This function does not delete domains from the specified folder - instead they are moved to the "(Default)" folder.

Example query:

https://www.above.com/api.php?username=user&password=pass&api_key=key&mode=delete_folder&folder= parked%20domains1

Response:

    <results>

      <result jobid="14524" status="Processing"/>

    </results>

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

In this example, we will delete the folder "parked domains2" (folder=parked%20domains2).

Example query:

https://www.above.com/api.php?username=user&password=pass&api_key=key&mode=delete_folder&folder= parked%20domains2

Response:

    <results status="Success" />

Error Responses:

Possible error responses for this function are:

• 413 - Folder does not exist / The (Trash) and (Default) folders may not be deleted
• 500 - Job failed. Please contact support if problems persist.
• General errors, such as 200 - Internal Error or 300 - Username or password invalid.

For a complete list of error responses, see the (/help.html?aid=23)Error Codes manual page](/help.html?aid=121).