---
title: "deleteSchemaAnnotation"
description: "Delete a schema annotation"
canonical: "https://pgbeam.com/docs/ts-sdk/schemaannotations/deleteSchemaAnnotation"
last-updated: "2026-10-24T21:15:09.000Z"
---

# deleteSchemaAnnotation

> Delete a schema annotation

URL: https://pgbeam.com/docs/ts-sdk/schemaannotations/deleteSchemaAnnotation

{/* Auto-generated from OpenAPI. Do not edit. Run `pnpm generate:sdk-docs` to regenerate. */}

Removes a single annotation identified by its natural key. Omit column_name to delete a table-level annotation, and omit schema_name to match the unqualified form.

## Usage

```typescript
const result = await api.schemaannotations.deleteSchemaAnnotation({
  pathParams: { project_id: "prj_xxx" },
  queryParams: { table_name: "..." },
});
```

## Parameters

| Parameter               | Type     | Required | Description                                               |
| ----------------------- | -------- | -------- | --------------------------------------------------------- |
| pathParams.project_id   | `string` | Yes      | Unique project identifier (prefixed, e.g. prj_xxx).       |
| queryParams.table_name  | `string` | Yes      | Relation (table or view) the annotation describes.        |
| queryParams.schema_name | `string` | No       | Optional schema. Omit to match the unqualified form.      |
| queryParams.column_name | `string` | No       | Optional column. Omit to delete a table-level annotation. |

## Response

`Promise<void>`: no content.

## Example

```typescript
import { PgBeamClient } from "pgbeam";

const client = new PgBeamClient({
  token: "pbu_...",
  baseUrl: "https://api.pgbeam.com",
});

const result = await client.api.schemaannotations.deleteSchemaAnnotation({
  pathParams: { project_id: "prj_xxx" },
  queryParams: { table_name: "...", schema_name: "...", column_name: "..." },
});
```

## Errors

| Status | Description                                                                                                                                                                                                                                                                                           |
| ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 400    | The request was rejected. `code` is `INVALID_INPUT`, and `errors` names the offending fields when the failure was a validation one.                                                                                                                                                                   |
| 401    | Missing or invalid authentication. `code` is `UNAUTHORIZED`.                                                                                                                                                                                                                                          |
| 403    | The caller is authenticated but not allowed to perform this operation. `code` is `FORBIDDEN` when the caller's role is insufficient, and `PLAN_LIMIT_REACHED` when the organization's plan is what stands in the way. The two are answered differently, so branch on the code rather than the status. |
| 404    | The resource does not exist, or the caller is not entitled to know that it does. `code` is `NOT_FOUND`.                                                                                                                                                                                               |
| 500    | The request failed for a reason on our side. `code` is `INTERNAL_ERROR`. Quote `request_id` when reporting it.                                                                                                                                                                                        |