updateTableRows

Updates specified rows in a table, allowing partial success with detailed feedback on errors.

PUT /v1/tables/{table}/rows

cURL

cURL

curl --request PUT \
  --url https://api.botpress.cloud/v1/tables/{table}/rows \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-bot-id: <x-bot-id>' \
  --data '
{
  "rows": [
    {
      "id": 123
    }
  ],
  "waitComputed": true
}
'

200

{
  "rows": [
    {
      "id": 123,
      "computed": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "stale": [
        "<string>"
      ],
      "similarity": 123
    }
  ],
  "warnings": [
    "<string>"
  ],
  "errors": [
    "<string>"
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-bot-id · string · required

Bot id

x-integration-id · string

Integration id

x-integration-alias · string

Integration alias

x-integration-name · string

Integration name

x-user-id · string

User Id

x-user-role · string

User Role

Path Parameters

table · string · required

The table's name or unique identifier for targeting specific table operations.

Body

application/json

Data for rows to update, including IDs. Errors affect only specific rows, not the entire batch.

rows · object[] · required

Rows with updated data, identified by ID.

Required array length: 1 - 1000 elements

Show child attributes

waitComputed · boolean

Ensure computed columns are fully processed before returning the result. This is applicable only when the number of rows involved is fewer than 1.

Response

200

application/json

Returns updated rows, including warnings for minor issues and errors for failed updates.

rows · object[] · required

Show child attributes

warnings · string[]

Alerts for minor issues that don't block the operation but suggest possible improvements.

errors · string[]

Critical issues in specific elements that prevent their successful processing, allowing partial operation success.