Database table rows

Changed on

Updates an existing row in the table if the user has access to the related table's workspace. The accepted body fields are depending on the fields that the table has. For a complete overview of fields use the list_database_table_fields endpoint to list them all. None of the fields are required, if they are not provided the value is not going to be updated. When you want to update a value for the field with id 10, the key must be named field_10. Or if the GET parameter user_field_names is provided the key of the field to update must be the name of the field. Multiple different fields to update can be provided in one request. In the examples below you will find all the different field types, the numbers/ids in the example are just there for example purposes, the field_ID must be replaced with the actual id of the field or the name of the field if user_field_names is provided.

patch/api/database/rows/table/{table_id}/{row_id}/

Request

  • Base URL
    https://api.baserow.io (the document declares no server; this is the origin it was published from)
  • URL
    https://api.baserow.io/api/database/rows/table/{table_id}/{row_id}/
  • Auth
    • HTTP bearer
    • or HTTP bearer

Path parameters

row_idinteger required

Updates the row related to the value.

table_idinteger required

Updates the row in the table related to the value.

Query parameters

send_webhook_eventsboolean

A flag query parameter that triggers webhooks after the operation, if set to y, yes, true, t, on, 1, or left empty. Defaults to true

user_field_namesboolean

A flag query parameter that, if provided with one of the following values: y, yes, true, t, on, 1, or an empty value, will cause this endpoint to expect and return the user-specified field names instead of the internal Baserow field names (e.g., field_123).

viewinteger

Provide if the row is updated in a view. This can result in different permission checking and default values.

Headers

ClientSessionIdstring uuid

An optional header that marks the action performed by this request as having occurred in a particular client session. Then using the undo/redo endpoints with the same ClientSessionId header this action can be undone/redone.

ClientUndoRedoActionGroupIdstring uuid

An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.

Request body

field_1string nullable

This field represents the text field. The number in field_1 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field.

field_2string nullable

This field represents the long_text field. The number in field_2 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field.

field_3string nullable

This field represents the url field. The number in field_3 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field.

field_4string nullable

This field represents the email field. The number in field_4 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field.

field_5string decimal nullable

This field represents the number field. The number in field_5 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field.

field_6integer

This field represents the rating field. The number in field_6 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field.

field_7boolean

This field represents the boolean field. The number in field_7 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field.

field_8string date nullable

This field represents the date field. The number in field_8 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field.

field_13number float nullable

This field represents the duration field. The number in field_13 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field. The provided value can be a string in one of the available formats or a number representing the duration in seconds. In any case, the value will be rounded to match the field's duration format.

field_14integer[]

This field represents the link_row field. The number in field_14 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field. This field accepts an array containing the ids or the names of the related rows. A name is the value of the primary key of the related row. This field also accepts a string with names separated by a comma or an array of row names. You can also provide a unique row Id.The response contains a list of objects containing the id and the primary field's value as a string for display purposes.

field_16integer nullable

Accepts one of the following option ids as integer value This field accepts an integer representing the chosen select option id related to the field. Available ids can be found when getting or listing the field. The response represents chosen field, but also the value and color is exposed..

field_17integer[]

This field represents the multiple_select field. The number in field_17 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field. This field accepts a list of integer each of which representing the chosen select option id related to the field. Available ids can be foundwhen getting or listing the field. You can also send a list of option names in which case the option are searched by name. The first one that matches is used. This field also accepts a string with names separated by a comma or an array of file names. The response represents chosen field, but also the value and color is exposed.

field_18string nullable

This field represents the phone_number field. The number in field_18 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field.

field_23integer[]

This field represents the multiple_collaborators field. The number in field_23 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field. This field accepts a list of objects representing the chosen collaborators through the object's id property. The id is Baserow user id. The response objects also contains the collaborator name directly along with its id.

field_26string nullable

This field represents the password field. The number in field_26 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field. Allows setting a write only password value. Providing a string will set the password, null will unset it, true will be ignored. The response will respond with true is a password is set, but will never expose the password itself.

field_29string nullable

This field represents the ai field. The number in field_29 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field. Holds a value that is generated by a generative AI model using a dynamic prompt.

Response

idinteger required

The unique identifier of the row in the table.

orderstring decimal

Indicates the position of the row, lowest first and highest last.

field_1string nullable

This field represents the text field. The number in field_1 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field.

field_2string nullable

This field represents the long_text field. The number in field_2 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field.

field_3string nullable

This field represents the url field. The number in field_3 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field.

field_4string nullable

This field represents the email field. The number in field_4 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field.

field_5string decimal nullable

This field represents the number field. The number in field_5 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field.

field_6integer

This field represents the rating field. The number in field_6 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field.

field_7boolean

This field represents the boolean field. The number in field_7 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field.

field_8string date nullable

This field represents the date field. The number in field_8 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field.

field_9string date-time

This field represents the last_modified field. The number in field_9 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field.

field_11string date-time

This field represents the created_on field. The number in field_11 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field.

field_13number float nullable

This field represents the duration field. The number in field_13 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field. The provided value can be a string in one of the available formats or a number representing the duration in seconds. In any case, the value will be rounded to match the field's duration format.

field_18string nullable

This field represents the phone_number field. The number in field_18 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field.

field_19string nullable

This field represents the formula field. The number in field_19 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field.

field_20string nullable

This field represents the count field. The number in field_20 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field.

field_21string nullable

This field represents the rollup field. The number in field_21 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field.

field_22string nullable

This field represents the lookup field. The number in field_22 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field.

field_24string uuid

This field represents the uuid field. The number in field_24 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field. Contains a unique and persistent UUID for every row.

field_25integer

This field represents the autonumber field. The number in field_25 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field. Contains a unique and persistent incremental integer number for every row.

field_26boolean

This field represents the password field. The number in field_26 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field. Allows setting a write only password value. Providing a string will set the password, null will unset it, true will be ignored. The response will respond with true is a password is set, but will never expose the password itself.

field_27string required

This field represents the form_view_edit_row field. The number in field_27 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field.

field_28string nullable

This field represents the button field. The number in field_28 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field.

field_29string nullable

This field represents the ai field. The number in field_29 is in a normal request or response the id of the field. If the GET parameter user_field_names is provided and its value is one of the following: y, yes, true, t, on, 1, or empty, then the key will instead be the actual name of the field. Holds a value that is generated by a generative AI model using a dynamic prompt.

Changes

  • e81714236040Revision changes
    • warning

      added the new ERROR_RICH_TEXT_IMAGE_LIMIT_EXCEEDED enum value to the response property for the response status

    • warning

      added the new ERROR_USER_FILE_DOES_NOT_EXIST enum value to the response property for the response status

    • info

      the endpoint scheme security UserSource JWT was removed from the API

  • 0c490e5b0c7fRevision changes
    • breaking

      the response property's maxLength was unset from 1000000 for the response status

    • warning

      removed the request property (media type: application/json)

    • warning

      removed the request property (media type: application/x-www-form-urlencoded)

    • warning

      removed the request property (media type: multipart/form-data)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: application/x-www-form-urlencoded)

    • info

      added the new optional request property (media type: multipart/form-data)

    • info

      added the optional property to the response with the status