PATCH /api/database/rows/table/{table_id}/batch/
Updates existing rows 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 for each row. 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.
WARNING: This endpoint doesn't yet work with row updated webhooks.
Servers
- /
Path parameters
Name | Type | Required | Description |
---|---|---|---|
table_id |
Integer | Yes |
Updates the rows in the table. |
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: |
send_webhook_events |
Boolean | No |
A flag query parameter that triggers webhooks after the operation, if set to |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
items[] |
Array | No | |
items[].field_17[] |
Array | No |
This field represents the |
items[].field_18 |
String | No |
This field represents the |
items[].field_8 |
String | No |
This field represents the |
items[].field_2 |
String | No |
This field represents the |
items[].field_3 |
String | No |
This field represents the |
items[].field_1 |
String | No |
This field represents the |
items[].field_6 |
Integer | No |
This field represents the Default value: 0 |
items[].field_7 |
Boolean | No |
This field represents the Default value: false |
items[].field_4 |
String | No |
This field represents the |
items[].field_5 |
String | No |
This field represents the |
items[].id |
Integer | Yes |
The unique identifier of the row in the table. |
items[].field_23[] |
Array | No |
This field represents the |
items[].field_23[].id |
Integer | Yes | |
items[].field_23[].name |
String | Yes | |
items[].field_13 |
Number | No |
This field represents the |
items[].field_14[] |
Array | No |
This field represents the |
items[].field_15[] |
Array | No |
This field represents the |
items[].field_26 |
String | No |
This field represents the |
items[].field_16 |
Integer | No |
This field represents the |
items[].field_27 |
String | Yes |
This field represents the |
How to start integrating
- Add HTTP Task to your workflow definition.
- 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.
- Click Test request to test run your request to the API and see the API's response.