Docs

upsertTableRows

Inserts or updates rows based on a key. If a row exists, it is updated; otherwise, a new row is created.

POST/v1/tables/{table}/rows/upsert

Authorization

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

Header parameters

x-bot-idstringrequired
Bot id
x-integration-idstring
Integration id
x-integration-aliasstring
Integration alias
x-integration-namestring
Integration name
x-user-idstring
User Id
x-user-rolestring
User Role

Path parameters

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

Request body

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

rowsobject[]required
keyColumnstringdefault: "id"
Determines if a row is inserted or updated. Defaults to "id".(min length: 1, max length: 30)
waitComputedboolean
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

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

insertedobject[]required
updatedobject[]required
warningsstring[]
Alerts for minor issues that don't block the operation but suggest possible improvements.
errorsstring[]
Critical issues in specific elements that prevent their successful processing, allowing partial operation success.