POST
/
v1
/
tables
/
{table}
/
rows
/
upsert
cURL
curl --request POST \
  --url https://api.botpress.cloud/v1/tables/{table}/rows/upsert \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-bot-id: <api-key>' \
  --data '{
  "rows": [
    {
      "id": 123
    }
  ],
  "keyColumn": "id",
  "waitComputed": true
}'
{
  "inserted": [
    {
      "id": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "computed": {},
      "stale": [
        "<string>"
      ],
      "similarity": 123
    }
  ],
  "updated": [
    {
      "id": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "computed": {},
      "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.

​
x-bot-id
string
header
required

Your bot ID.

Path Parameters

​
table
string
required

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

Body

application/json

Rows for insertion or update, with a key column to determine action. Supports partial successes.

​
rows
object[]
required
Required array length: 1 - 1000 elements
​
keyColumn
string
default:id

Determines if a row is inserted or updated. Defaults to "id".

Required string length: 1 - 30
​
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

Summary of insertions and updates, including any warnings or errors.

​
inserted
object[]
required
​
updated
object[]
required
​
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.