API_GenAddRecordForm

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

Overview

Use API_GenAddRecordForm to return the standard Quickbase Add record page for the table whose dbid you specify. The form contains edit fields for the user to complete and a Save button to add the record to the database.

If you want to pre-fill any fields, you can do so by supplying one or more field/value pairs in the request. Any fields not pre-filled or completed by the user are set to the default values set in the table field properties.

Note: When using this API call from a formula url or rich text field button, some sort of change needs to be made on the form for the form to save. For example, if you make a url button that opens a Gen Add Record form with a lot of fields filled in and the user doesn't fill in or edit any additional fields, the record won't save when save is clicked. But if one of the pre-filled form fields is edited or another field is changed, then the record will save after clicking save.

Request parameters

Parameter	Value	Required?
field	Specify the field name or fid to be pre-filled in the form and its value. Format the value as it is formatted in API_AddRecord. For example: `<field name="Vehicle Make">Ford</field>`, or `<_fid_11>1234</_fid_11>`	yes
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.	no
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

Returns an HTML page containing the Add record page with any prefilled values.

Sample XML Request

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

<qdbapi>
   <udata>mydata</udata>
   <ticket>auth_ticket</ticket>
   <apptoken>app_token</apptoken>
   <field name='email'>bada@bing.com</field>
</qdbapi>

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

URL alternative

https://target_domain/db/bdec4pdva?a=API_GenAddRecordForm&_fid_11=
GoodBye&_fid_23=Four%20score%20and%20seven%20years&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.