> ## Documentation Index
> Fetch the complete documentation index at: https://velt.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Check Settings

Use this API to update a project's checks settings: the confidence floor, your own flags and the default owners. A field set to `null` is cleared. A field left out is kept. The response is the settings the engine now applies, as [Get Check Settings](https://velt.dev/docs/api-reference/rest-apis/v2/agents/checks/settings/get.md) returns them.

# Endpoint

`POST https://api.velt.dev/v2/agents/checks/settings/update`

# Headers

**x-velt-api-key** `string` *required*

Your API key.

**x-velt-auth-token** `string` *required*

Your [Auth Token](https://velt.dev/docs/security/auth-tokens.md).

# Body

#### Params

**data** `object` *required*

**properties**

**organizationId** `string` *required*

1 to 512 characters. The organization of the project.

**documentId** `string` *required*

1 to 512 characters. The document of the project.

**settings** `object` *required*

The settings to change. Every key is optional; `null` clears it.

| Key | Type | Description |
| - | - | - |
| `confidenceFloor` | number \| null | 0 to 100. A finding under it writes no comment. Default: `50`. |
| `hostFlags` | object \| null | Your own boolean flags, by name (1 to 120 characters). Stored and returned, never read by the engine. A flag set to `null` is removed; `hostFlags: null` removes them all. |
| `owners` | object \| null | `{ content?, design?, dev?, admin? }`, each `{ userId, name?, email? }` or `null`. The default owner of a check by its responsibility; `admin` is the fallback. An owner set to `null` is removed; `owners: null` removes them all. |

The schema uses `.strict()`: unknown fields, in `data`, `settings`, `owners` or an owner, are rejected.

## **Example Requests**

#### 1. Raise the floor and set the dev owner

```JSON theme={null}
{
  "data": {
    "organizationId": "org_acme",
    "documentId": "acme-marketing-site",
    "settings": {
      "confidenceFloor": 60,
      "owners": {
        "dev": {
          "userId": "user_jordan",
          "name": "Jordan Lee",
          "email": "jordan@example.com"
        }
      }
    }
  }
}
```

#### 2. Set a flag and clear the floor

```JSON theme={null}
{
  "data": {
    "organizationId": "org_acme",
    "documentId": "acme-marketing-site",
    "settings": {
      "confidenceFloor": null,
      "hostFlags": {
        "weeklyDigest": true
      }
    }
  }
}
```

# Response

#### Success Response

```JSON theme={null}
{
  "result": {
    "status": "success",
    "message": "Check settings updated",
    "data": {
      "confidenceFloor": 60,
      "hostFlags": {},
      "owners": {
        "dev": {
          "userId": "user_jordan",
          "name": "Jordan Lee",
          "email": "jordan@example.com"
        }
      },
      "source": "mirror",
      "updatedAt": 1761465600000
    }
  }
}
```

See [Get Check Settings](https://velt.dev/docs/api-reference/rest-apis/v2/agents/checks/settings/get.md) for the fields.

#### Failure Response

```JSON theme={null}
{
  "error": {
    "message": "ERROR_MESSAGE",
    "status": "INVALID_ARGUMENT",
    "details": {
      "issues": [
        { "code": "too_big", "path": ["settings", "confidenceFloor"], "message": "Number must be less than or equal to 100" }
      ]
    }
  }
}
```

**Errors:** `INVALID_ARGUMENT` (a body outside the schema: a missing `settings`, a `confidenceFloor` outside `0..100`, a flag that is not a boolean or `null`, an owner without `userId`, or an unknown field) / `NOT_FOUND` with `CHECKS_WORKSPACE_NOT_FOUND` (the workspace has no store database).

```js theme={null}
{
  "result": {
    "status": "success",
    "message": "Check settings updated",
    "data": {
      "confidenceFloor": 50,
      "hostFlags": { "weeklyDigest": true },
      "owners": {},
      "source": "mirror",
      "updatedAt": 1761465600000
    }
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.