API_DeleteRecord
Don't forget to check out our JSON RESTful APIs, they can help you utilize and extend Quickbase with ease.
Overview
Use API_DeleteRecord to delete a single record from a table. You invoke this call on a table-level dbid. If you use an application level dbid, you’ll get an error.
You must have Full Administration permissions on the application to use this call.
Note that this call allows you to delete one record at a time. If you want to delete several records at once, see API_PurgeRecords.
Request parameters
| Parameter | Value | Required? |
|---|---|---|
rid or key | The record ID of the record to be deleted. You can obtain the record ID of any record in a query. (See API_DoQuery). If you use a key field OTHER than the record id (rid), you should use the <key> parameter rather than <rid>. | yes |
ticket | A valid authentication ticket. The authentication ticket is returned via the API_Authenticate call. | yes, one of:
|
usertoken | A user token – this is a ticket alternative, used for API access |
yes, one of:
|
apptoken | Supply 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_DeleteRecord. |
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. |
rid | The record ID of the deleted record. |
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_DeleteRecord
<qdbapi>
<udata>mydata</udata>
<ticket>auth_ticket</ticket>
<apptoken>app_token</apptoken>
<rid>18</rid>
</qdbapi>
URL alternative
https://target_domain/db/target_dbid?a=API_DeleteRecord&rid=18
&udata=mydata&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_DeleteRecord</action>
<errcode>0</errcode>
<errtext>No error</errtext>
<rid>18</rid>
</qdbapi>
