---
title: "createApprovalRule"
description: "Create an approval rule"
canonical: "https://pgbeam.com/docs/ts-sdk/approvals/createApprovalRule"
last-updated: "2026-11-09T17:53:44.000Z"
---

# createApprovalRule

> Create an approval rule

URL: https://pgbeam.com/docs/ts-sdk/approvals/createApprovalRule

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

Sends the agent statements the rule matches to a human for approval, whatever the policy profile's approval_mode says. A rule can only add approval; nothing here can exempt a statement from approval_mode.

The rule is pushed to connected data planes when it is written. A reviewer sees its name on every approval request it holds.

Returns 409 for an enabled rule while the organization has a live self-hosted data plane enrollment, because PgBeam cannot yet confirm that a self-hosted proxy runs a build that enforces approval rules. A rule with enabled set to false is still accepted.

## Usage

```typescript
const result = await api.approvals.createApprovalRule({
  pathParams: { project_id: "prj_xxx" },
  body: {
    name: "payments deletes",
  },
});
```

## Parameters

| Parameter              | Type                          | Required | Description                                                                                                                                                                                                                                                           |
| ---------------------- | ----------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| pathParams.project_id  | `string`                      | Yes      | Unique project identifier (prefixed, e.g. prj_xxx).                                                                                                                                                                                                                   |
| body.name              | `string`                      | Yes      | Label shown to the reviewer on every approval request this rule holds. Must be unique within the project and not blank.                                                                                                                                               |
| body.statement_kinds   | `ApprovalRuleStatementKind[]` | No       | Statement kinds the rule holds. Empty or omitted holds every kind.                                                                                                                                                                                                    |
| body.schema_name       | `string`                      | No       | Schema to scope the rule to. Null, empty or omitted matches every schema.                                                                                                                                                                                             |
| body.relation_name     | `string`                      | No       | Relation to scope the rule to. Null, empty or omitted matches every relation. Without a schema it matches that name in every schema.                                                                                                                                  |
| body.min_affected_rows | `number`                      | No       | Hold only statements affecting at least this many rows. Must be at least 1. Null or omitted holds every matching statement. The count is taken in a rolled-back trial run; a statement that reports no count (DDL, a batch, a data-modifying CTE) is held regardless. |
| body.enabled           | `boolean`                     | No       | False switches the rule off, so it holds nothing.                                                                                                                                                                                                                     |

## Response

`Promise<ApprovalRule>`: approval rule created.

## Example

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

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

const result = await client.api.approvals.createApprovalRule({
  pathParams: { project_id: "prj_xxx" },
  body: {
    name: "payments deletes",
  },
});
```

## 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`.                                                                                                                                                                                                                               |
| 409    | The request conflicts with the current state. `code` distinguishes the cases: `RESOURCE_EXISTS` for a name or value already in use, `INVALID_STATE` for a resource that is no longer in a state that allows the operation, and `IDEMPOTENCY_KEY_REUSED` for a retry whose body does not match the request the key was first used for. |
| 413    | The request body exceeds the 2 MB limit. `code` is `PAYLOAD_TOO_LARGE`.                                                                                                                                                                                                                                                               |
| 415    | The request body is not JSON, or carries a body without declaring a Content-Type. `code` is `UNSUPPORTED_MEDIA_TYPE`.                                                                                                                                                                                                                 |
| 429    | Rate limited. `code` is `RATE_LIMITED`.                                                                                                                                                                                                                                                                                               |
| 500    | The request failed for a reason on our side. `code` is `INTERNAL_ERROR`. Quote `request_id` when reporting it.                                                                                                                                                                                                                        |