---
title: "deleteSchemaAnnotation"
description: "Delete a schema annotation"
canonical: "https://pgbeam.com/docs/ts-sdk/schemaannotations/deleteSchemaAnnotation"
last-updated: "2026-09-09T11:37:53.000Z"
---

# deleteSchemaAnnotation

> Delete a schema annotation

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

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

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

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