Don't forget to check out our JSON RESTful APIs, they can help you utilize and extend Quickbase with ease.
Overview
Use API_DeleteField to delete a field by specifying the field id (fid). You invoke this call on a table-level dbid. (If you use an application level dbid, Quickbase returns an error.)
You must have Full Administration permissions on the application to use this call.
This call deletes the field for all records, regardless of whether the field contains data. Note that the call does not issue a warning message before the deletion.
Request parameters
| Parameter | Value | Required? |
|---|---|---|
|
fid |
The field ID of the field to be deleted. |
yes |
|
ticket |
a ticket – needed for application access |
yes, one of:
|
|
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:
|
|
apptoken |
Supply a valid application token. |
yes, if app tokens are being used by this application. |
|
udata |
A string value that you want returned. It will not be handled by Quickbase but it will be returned in the response. One possible use is to maintain state in the calling application. |
no |
Response values
| Element Name | Value |
|---|---|
|
action |
Echoes the originating request, for example, API_AddField. |
|
errcode |
If successful, this will be 0. If there is a failure, there will be a code returned here. See Appendix A for a list of codes. |
|
errtext |
If successful, this will be “No error”. If there is a failure this contains more detail on the nature of the failure. |
|
udata |
Optional. 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_DeleteField
<qdbapi>
<ticket>auth_ticket</ticket>
<apptoken>app_token</apptoken>
<fid>8</fid>
<udata>whatever</udata> <!--optional-->
</qdbapi>
URL alternative
https://target_domain/db/target_dbid?a=API_DeleteField&fid=FID&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_DeleteField</action>
<errcode>0</errcode>
<errtext>No error</errtext>
</qdbapi>