> ## 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.

# Exclude Check

Use this API to exclude a check for a project, with one of the four [reject reasons](https://velt.dev/docs/api-reference/rest-apis/v2/agents/checks/overview.md#reject-reasons). The check's state becomes `excluded`:

* it leaves the score (its `scoreImpact` is `0`) and counts none of its comments (its `openCount` and `pageCount` are `0`);
* its open agent comments are [rejected](https://velt.dev/docs/api-reference/rest-apis/v2/agents/checks/comments/reject.md) with the reason `excluded`. Their status does not change. A person's comment [attached](https://velt.dev/docs/api-reference/rest-apis/v2/agents/checks/comments/attach.md) to the check, and an accepted suggestion, stay as they are;
* its findings write no comment. The agent still runs.

[Include Check](https://velt.dev/docs/api-reference/rest-apis/v2/agents/checks/include.md) undoes it.

# Endpoint

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

# 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.

**ruleKey** `string` *required*

The check. `[a-z0-9:-]`, at most 120 characters.

**reason** `string` *required*

`"wrong"`, `"not_important"`, `"not_applicable"` or `"cannot_tell"`.

**userId** `string` *required*

1 to 512 characters. Recorded as the person who excluded the check.

The schema uses `.strict()`: unknown fields are rejected.

## **Example Requests**

```JSON theme={null}
{
  "data": {
    "organizationId": "org_acme",
    "documentId": "acme-marketing-site",
    "ruleKey": "link-unlinked-email",
    "reason": "not_important",
    "userId": "user_sam"
  }
}
```

# Response

#### Success Response

```JSON theme={null}
{
  "result": {
    "status": "success",
    "message": "Check excluded",
    "data": {
      "excluded": true
    }
  }
}
```

#### Failure Response

```JSON theme={null}
{
  "error": {
    "message": "Workspace not found or has no store database for the checks engine",
    "status": "NOT_FOUND",
    "details": {
      "reason": "CHECKS_WORKSPACE_NOT_FOUND"
    }
  }
}
```

**Errors:** `INVALID_ARGUMENT` (a body outside the schema: a missing or malformed `ruleKey`, a `reason` outside the four, a missing `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 excluded",
    "data": {
      "excluded": true
    }
  }
}
```


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