API Queries - Delete Folder

The delete_folder function deletes a folder. All keywords must be removed from a folder before it can be deleted.


Additional Parameters

  • folder - Folder to be deleted. Does not accept multiple folders. (Required)
  • type - Specifies the format of the API response. Set to "json" for a JSON response; otherwise, the response will be in XML. (Optional)

Example query and response:

In this example, we will be deleting the folder "Credit Cards".

Example query:



http://bid.trellian.com/api.html?username=user&api_key=key&mode=delete_folder
&folder=Credit%20Cards

Response (XML):



<results>
<result Status="Deleted"/>
</results>

Response (JSON):



                {
                "results": [ 
                {
                "Status": "Deleted"
                }
                ]
                }
            

The above response means that the folder was successfully deleted from the system.


Error Responses:

Possible error responses for this function are:

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