Skip to main content
POST
Start a background Database mutation

Authorizations

Authorization
string
header
required

Bearer JWT token or API Key (sk-*).

Body

application/json
databaseName
string
required

Database ID/name, or view ID when viewAction is provided.

action
enum<string>
required
Available options:
UPDATE,
DELETE,
TRUNCATE
request
object

Filtered selection. Returning rows is not supported in background operations.

data
object
viewAction
object

Reviewed view mutation. The preview token is validated at admission.

restartIdentity
boolean
default:false
skipNotification
boolean
default:false

Suppress the terminal System message. Low-code defaults this to true.

idempotencyKey
string<uuid>

Actor-scoped admission key. Reusing it with a different request is rejected.

Response

202 - application/json
accepted
boolean
required
jobId
string<uuid>
required
status
string
required
Last modified on October 5, 2026