Use API_EditRecord to change any editable field values in the specified record. Only those fields specified are changed; unspecified fields are left unchanged.

You can specify either field names or field IDs when using this call.


Request parameters

The following request parameters are available:

Parameter Value Required?

rid or key

The record ID of the record to be edited. You can obtain the recordID 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.



Specifies the latest record state.

Note that, if another user makes changes before you issue this call,  the update ID in Quick Base will change, which will render invalid the update ID that you have. In this case, you should get the latest version of the record and its new update ID, and then make your changes.

You can obtain the update ID for a record using the API_GetRecordInfo for the record you are editing.



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.



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

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



Set this parameter to 1 if you are invoking API_EditRecord from within an HTML form that has checkboxes and want those checkboxes to set Quick Base checkbox fields.

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



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_EditRecord call.

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



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.

yes, one of:

  • ticket
  • username/password
  • user token


The user token is an alternative means of authentication, used for API access. User tokens cannot be used to access the Quick Base UI.

yes, one of:

  • ticket
  • username/password
  • user token


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

yes, if the application requires application tokens


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



Allows you to specify that Quick Base 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.



Set this parameter to a period-delimited list of field IDs, for example: <clist></clist>. This indicates how the columns in the CSV file will map to fields in the table when the import occurs.

To prevent a column in the CSV file from being imported, enter a 0 in the field ID list. To import all columns, enter a as the clist parameter.

This means that the first field ID in the list maps to the first column in the CSV file, the second field ID maps to the second column in the CSV file, and so forth.

For example <clist></clist>, contains four columns. Quick Base will not import either the first or the third columns. The second column will map to field ID 7, and the fourth column will map to field ID 6.

yes, if you are updating records, or you want the columns in the CSV file to map to certain fields in the table


Response values

The response to this call contains the following:

Element Name Value


Echoes the originating request, for example, API_AddField.


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.


Text that explains the error code.

"No error" indicates that no error was encountered.


Optional. Contains any udata value supplied in the request.


Record ID of the record that was edited


The number of record fields successfully updated in the edit.


This parameter is 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.


Sample XML Request

POST https://target_domain/db/target_dbid HTTP/1.0
Content-Type: application/xml

Using Field Names

  <field name="start_date">06-08-2008</field>
   <field name="attendee_name">Joseph Riesentrotter</field>

Using Field IDs

  <field fid="11">06-08-2008</field>
  <field fid="12">Joseph Riesentrotter</field>


URL alternative


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" ?>
   <errtext>No error</errtext>