Skip to main content
POST
Execute one bounded database write in Dev or Prod

Authorizations

Authorization
string
header
required

WorkOS access JWT or a user-owned WorkOS API key. User keys are bound to one organization and restricted to their enabled product permissions. Session-only onboarding and session revocation require an interactive access JWT. No cookie session is assumed.

Headers

X-Request-Id
string

Optional caller-provided correlation identifier.

Required string length: 1 - 128
Idempotency-Key
string
required

Identifies one mutation and its canonical request payload.

Required string length: 1 - 128

Path Parameters

project_id
string
required

Project identifier.

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$

Body

application/json
environment
enum<string>
required
Available options:
dev,
prod
statement
string
required

One direct INSERT, UPDATE or DELETE, max 64 KiB UTF-8; entire JSON request is limited to 65,600 bytes.

Required string length: 1 - 65536
parameters
any[]
required

JSON values, at most 8 levels and 10000 nodes, max 64 KiB encoded.

Maximum array length: 100

Response

Terminal receipt; failed state is not a successful write.

operation_id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
environment
enum<string>
required
Available options:
dev,
prod
state
enum<string>
required
Available options:
running,
succeeded,
failed
command
enum<string> | null
required
Available options:
INSERT,
UPDATE,
DELETE,
null
affected_rows
integer | null
required
Required range: 0 <= x <= 1000
error
object | null
required