Skip to main content
POST
db.rows.update

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
table
string
required

Table name: letters, digits and underscores, starting with a letter or underscore (max 63).

Pattern: ^[A-Za-z_][A-Za-z0-9_]{0,62}$
values
object
required

The new values: { column: value }, 1 to 500 columns. Values are data, never SQL.

schema
string
default:public

Database schema the table is in. Default "public".

Pattern: ^[A-Za-z_][A-Za-z0-9_]{0,62}$
filters
object[]

Conditions every row must meet (AND), 1 to 20. At least one is required, so a change never hits every row.

Maximum array length: 20
returning
string[]

Columns to return for the updated rows, 1 to 100. None are returned when omitted.

Required array length: 1 - 100 elements

Column name.

Pattern: ^[A-Za-z_][A-Za-z0-9_]{0,62}$

Response

The result

count
number
required

Rows affected.

results
object[]

The affected rows, only the columns asked for in returning.

truncated
boolean

Present when rows were dropped to stay under 1 MB.