API_DeleteDatabase

Don't forget to check out our JSON RESTful APIs, they can help you utilize and extend Quickbase with ease.

Overview

Use API_DeleteDatabase to delete a table or an entire application. Supply an application-level dbid to delete an application; supply a table-level dbid to delete a table.

If you use this API to delete an app, you must be the app manager, or the API will return an error. If you use this API to delete a table, you must have Full Administration permissions in the app, or the API will return an error.

Request parameters

Parameter	Value	Required?
ticket	A valid authentication ticket. The authentication ticket is returned via the API_Authenticate call.	yes, one of: ticket username/password user token
usertoken	The user token is an alternative means of authentication, used for API access. User tokens cannot be used to access the Quickbase UI.	yes, one of: ticket username/password user token
apptoken	A valid application token.	yes, if the application requires application tokens
udata	A string value that you want returned. It will not be handled by Quickbase but it will be returned in the response.	no

Response values

Element Name	Value
action	The originating request, for example, API_DeleteDatabase.
errcode	Identifies the error code, if any. (See the Error Codes appendix for a list of possible error codes.) 0 indicates that no error was encountered.
errtext	Text that explains the error code. "No error" indicates that no error was encountered.
udata	Contains any udata value supplied in the request.

Sample XML Request

POST https://target_domain/db/target_dbid
 HTTP/1.0
Content-Type: application/xml
Content-Length:
QUICKBASE-ACTION: API_DeleteDatabase

<qdbapi>
   <ticket>auth_ticket</ticket>
   <apptoken>app_token</apptoken>
</qdbapi>

URL alternative

https://target_domain/db/target_dbid?a=API_DeleteDatabase
&ticket=auth_ticket&apptoken=app_token

where target_domain is the domain against which you are invoking this call, for example, quickbase.com. Read about this notation.

Sample response

<?xml version="1.0" ?>
<qdbapi>
   <action>API_DeleteDatabase</action>
   <errcode>0</errcode>
   <errtext>No error</errtext>
</qdbapi>