API_AddRecord

field

Specify values for the fields that make up the record you want to add using either the fid attribute or name attribute of the <field> element.

For example:

<field fid="18">Hi!</field>
<field name="Message">Hi!</field>

You must specify all required fields.

The values you enter here will vary, depending on field type. See How to specify values for different field types for more information.

yes

disprec

Set this parameter to 1 to specify that the new record should be displayed within the Quickbase application. An application login required before the record can be displayed. If you use this parameter, Quickbase, returns the normal Quickbase HTML page that displays the record.

Omit this property if you don't want the new record to display within the Quickbase application.

no

fform

Set this parameter to 1 if you are invoking API_AddRecord from within an HTML form that has checkboxes and want those checkboxes to set Quickbase Checkbox fields.

Omit this property if you don't need Quickbase to set Checkbox fields based on your HTML page.

no

ignoreError

Set this parameter to 1 to specify that no error should be returned when a built-in field (for example, Record ID#) is written-to in an API_AddRecord call.

If you do not set this parameter, Quickbase returns an error when API_AddRecord writes to a built-in field.

no

ticket

Specifies valid authentication ticket. You obtain a valid ticket from API_Authenticate. A ticket is also returned in the various API responses. See API Overview for more information on the authentication ticket.

No.

usertoken

A user token – this can be used for API access and is the preferred alternative to a ticket or application token.

yes, one of:

• ticket
• username/password
• user token

apptoken

Specifies a valid application token. See API Overview for more information on application tokens.

yes, if the application requires application tokens and you are not using a user token

udata

A string value that you want returned. It will not be handled by Quickbase but it will be returned in the response.

no

msInUTC

Allows you to specify that Quickbase should interpret all date/time stamps passed in as milliseconds using Coordinated Universal Time (UTC) rather than using the local application time.

Set this parameter to 1 if you want to use Coordinated Universal Time. See usage example.

no

Set this parameter to 1 to specify milliseconds, instead of days, as the default units for a duration field value sent without any units.

If you set this parameter to 0 or omit it, then any duration field values sent without a unit will default to being interpreted as days.

clist

A period-delimited list of field IDs to be returned. Quickbase will return values for these field IDs in the order in which you enter them here.

To return all fields in a table, set this parameter to the value a.

Allows you to return the state of dynamic fields like formulas, lookups or summaries without combining with API_DoQuery.

no

Text

Any characters, special characters, numbers, or symbols. Note that non-alphanumeric characters (anything other than A-Z, a-z, and 0-9) may need to be encoded to appear as intended in your data.

Text -
Multi-line

Any characters, special characters, numbers, or symbols. Note that non-alphanumeric characters (anything other than A-Z, a-z, and 0-9) may need to be encoded to appear as intended in your data.

Text -
Multiple Choice

A valid choice that has been set up for the multiple choice field. Note that Quickbase does not validate case here; if you enter "ford" and, in your application, the choice is "Ford," the choice will be accepted.

If you enter an invalid choice, Quickbase generates an error.

Multi-select Text

Up to 20 valid choices from the list set up for the field, separated by semi-colons. The set of choices provided must not contain duplicates.

Note: Choices added to a Multi-select Text field are limited to 60 characters, and the total number of choices in the field may not exceed 100.

Numeric

Positive or negative numbers. Quickbase ignores any non-numeric characters you enter here, but will not generate an error.

If you've specified decimal places using API_SetFieldProperties, the value will be truncated  or lengthened accordingly.

Numeric - Currency

Positive and negative numbers, with or without decimals. The decimal character should match the decimal character set in the field's properties.

Numeric - Percent

A number that represents the percentage. Note that, if you want to indicate 80%, you should enter 80 in this field.

Numeric - Rating

A numeric rating, from 1 - 5. Quickbase displays ratings as stars; if you enter 3 in a Numeric-Rating field, Quickbase displays 3 out of 5 stars selected.

Date

A date in the format specified in the app's properties.

Alternatively, a date in milliseconds since January 1, 1970 00:00:00 UTC.  Note that the Quickbase HTTP API returns dates in this format, which is the same internal representation used by JavaScript.

Date/Time

A date and time. Dates should be in the format specified in the app's properties.

This field is an extended date field that can also contain the time, in the format HH:MM AM/PM. If you don't specify AM or PM, Quickbase defaults to AM. If you don't specify a time, Quickbase defaults to 12:00 AM.

Time of Day

A time in this format: HH:MM AM/PM.

If you do not specify AM or PM, Quickbase defaults to AM.

Duration

A number that indicates a period of time. Note that you must use API_SetFieldProperties to set the unit of measure.

If you enter a non-numeric value here, Quickbase ignores the value (no error is generated.)

Checkbox

A string that indicates whether the checkbox is checked or not.

To specify that a checkbox is checked, enter any of these values:

• 1

• yes

• true

• on

To specify that a checkbox is not checked, enter any string other than those listed above, or leave the parameter blank. If a Checkbox field is required, and does not default to "checked," you must enter some value to be able to save the record.

Phone Number

A phone number, with or without an extension. Enter a 10-digit string of numbers. You are not required to enter special characters (parentheses or dashes).

Example: For this phone number: (123) 456-7890

...enter  1234567890

If you want to include an extension, you can enter x after the last digit of the phone number, followed by the numeric characters that make up the extension. There is no minimum or maximum character limit on extensions.

Example: For this phone number:(123) 456-7890 x9876

...enter  1234567890x9876

Quickbase ignores any non-numeric character you enter here (except for the x used for extensions).

Email Address

An email address (joeuser@example.com).

Note that if you enter an invalid email address, Quickbase does not generate an error.

User

A Quickbase user's email address or Quickbase user name.

List-User

Quickbase users' email addresses, Quickbase user names, or hashed user IDs, separated by semi-colons.

Example: joe@example.com;sue@example.com

File Attachment

A base64-encoded file. See Managing Files for more information about uploading files.

Note that you must not use MIME encoding and must not include MIME headers. Note that many base64 encoders or base64 encoding methods are for MIME type encoding and will not work with Quickbase.

You must not insert any newline characters when you encode the file. If your file attachments appear to upload but don’t display in Quickbase, double check for these characters.  

In the opening <field> tag, insert the filename attribute in addition to the fid or name attribute, as shown in this example:

<field fid="22" filename="profilePhoto.jpg">

The filename attribute value should be set to the name of the file with no path specified. Insert the base64-encoded text from the encoded file between the opening and closing <field> tags.

URL

A Web address. If you don't enter "http://", Quickbase adds it for you.

Note that if you enter an invalid Web address, Quickbase does not generate an error.

Report Link

Report links are derived from other fields. You can update which report is linked to by updating the field that the report link refers to. You can't write to this type of field directly. If your API writes to a Report Link field, Quickbase ignores the call.

iCalendar

iCalendar fields are derived from other fields. You can update this type of field only by updating the fields to which it refers. You can't write to this type of field directly. If your API writes to an iCalendar field, Quickbase returns an error.

vCard

vCard fields are derived from other fields. You can update this type of field only by updating the fields to which it refers.  You can't write to this type of field directly If your API writes to a vCard field, Quickbase returns an error.

Predecessor

The Record ID of the predecessor record. Note that if you enter an invalid Record ID here, Quickbase returns an error.

Formula fields

Formula fields are derived from other fields. You cannot write to this type of field directly. If your API writes to a formula field, Quickbase returns an error.

action

The originating request, for example, API_AddRecord.

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

Optional. Contains any udata value supplied in the request.

rid

Record ID of the record that was added

update_id

Used to detect update conflicts when invoking API_EditRecord.

You could save this update ID when you add a new record, but it would be better to instead get the most recent update_id value later when you query for the record to get it and update it.