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

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.

Servers

Path parameters

Name Type Required Description
table_id Integer Yes

Updates the row in the table related to the value.

row_id Integer Yes

Updates the row related to the value.

Request headers

Name Type Required Description
ClientSessionId String No

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.

Content-Type String Yes The media type of the request body.

Default value: "application/json"

ClientUndoRedoActionGroupId String No

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.

Query parameters

Name Type Required Description
user_field_names Boolean No

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).

send_webhook_events Boolean No

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

Request body fields

Name Type Required Description
field_17[] Array No

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_18 String No

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_8 String No

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_2 String No

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_3 String No

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_1 String No

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_6 Integer No

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.

Default value: 0

field_7 Boolean No

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.

Default value: false

field_4 String No

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_5 String No

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_23[] Array No

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_23[].id Integer Yes
field_23[].name String Yes
field_13 Number No

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_14[] Array No

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_15[] Array No

This field represents the file field. The number in field_15 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 objects with the name of the file. The response contains an array of more detailed objects related to the files.

field_26 String No

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_16 Integer No

This field represents the single_select field. The number in field_16 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 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_27 String No

This field represents the ai 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. Holds a value that is generated by a generative AI model using a dynamic prompt.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.