Skip to content

Replace compliance settings (whole-object PUT)

Requires EDITOR. Whole-object overwrite; companyName/physicalAddress are required (nullable) keys; emailLocaleStrict is a required boolean.

projectId
required
string

Tenant project id (row-level isolation on every query).

Media typeapplication/json
object
companyName
required
string | null
>= 1 characters <= 200 characters
physicalAddress
required
string | null
>= 1 characters <= 500 characters
contact
string | null
<= 200 characters
emailLocaleStrict
required
boolean
Examplegenerated
json
{
"companyName": "example",
"physicalAddress": "example",
"contact": "example",
"emailLocaleStrict": true
}

Saved settings.

Media typeapplication/json
object
settings
object
key
additional properties
any

Request body failed Zod validation.

Media typeapplication/json

Validation error envelope with per-field issues.

object
error
string
issues
Array<object>
object
path
string
message
string
Examplegenerated
json
{
"error": "example",
"issues": [
{
"path": "example",
"message": "example"
}
]
}

Not authenticated (no valid session/principal).

Media typeapplication/json
object
error
required

Human-readable error message.

string
message
string
Examplegenerated
json
{
"error": "example",
"message": "example"
}

Authenticated but lacks the required project role.

Media typeapplication/json
object
error
required

Human-readable error message.

string
message
string
Examplegenerated
json
{
"error": "example",
"message": "example"
}