--- title: "updateQueryTemplate" description: "Update a query template" canonical: "https://pgbeam.com/docs/ts-sdk/policies/updateQueryTemplate" last-updated: "2026-10-20T10:24:51.000Z" --- # updateQueryTemplate > Update a query template URL: https://pgbeam.com/docs/ts-sdk/policies/updateQueryTemplate {/* Auto-generated from OpenAPI. Do not edit. Run `pnpm generate:sdk-docs` to regenerate. */} Replaces the template's name, description, SQL, parameters, include_sql and enabled flag. The SQL is checked as on create. A statement already admitted under the old template is not affected; the next one is matched against the new text. Returns 409 on a rename to a name the project already uses, and when the update leaves the template enabled while the organization has a live self-hosted data plane enrollment, for the same reason as create. Setting enabled to false is still accepted. ## Usage ```typescript const result = await api.policies.updateQueryTemplate({ pathParams: { project_id: "prj_xxx", query_template_id: "qtp_xxx" }, body: { name: "open_orders_for_customer", sql: "SELECT id, total FROM orders WHERE customer_id = $1 AND status = 'open' ORDER BY created_at DESC", }, }); ``` ## Parameters | Parameter | Type | Required | Description | | ---------------------------- | ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | pathParams.project_id | `string` | Yes | Unique project identifier (prefixed, e.g. prj_xxx). | | pathParams.query_template_id | `string` | Yes | Unique query template identifier (prefixed, e.g. qtp_xxx). | | body.name | `string` | Yes | Name an agent invokes the template by. A lower-case identifier starting with a letter, at most 63 characters, unique within the project. | | body.description | `string` | No | What the template is for, shown to an agent that lists the templates. | | body.sql | `string` | Yes | The statement, with its parameters as $1, $2 and so on. Exactly one SELECT, INSERT, UPDATE or DELETE, at most 16384 bytes. Every placeholder must be declared in params and every declared parameter must be used. | | body.params | `QueryTemplateParam[]` | No | Declared parameters, in placeholder order. Omitted means none. | | body.include_sql | `boolean` | No | True shows the SQL text to an agent that lists the templates. Defaults to false, since a WHERE clause can itself be sensitive. | | body.enabled | `boolean` | No | Defaults to true, so a template is admitted as soon as it is written. False saves it withdrawn. | ## Response `Promise`: updated query template. ## Example ```typescript import { PgBeamClient } from "pgbeam"; const client = new PgBeamClient({ token: "pbu_...", baseUrl: "https://api.pgbeam.com", }); const result = await client.api.policies.updateQueryTemplate({ pathParams: { project_id: "prj_xxx", query_template_id: "qtp_xxx" }, body: { name: "open_orders_for_customer", sql: "SELECT id, total FROM orders WHERE customer_id = $1 AND status = 'open' ORDER BY created_at DESC", }, }); ``` ## 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. | | 412 | The `If-Match` entity tag does not match the current representation, so the resource changed after the read this write was based on. Nothing was modified. `code` is `PRECONDITION_FAILED`. Re-read the resource, re-apply the change, and retry with the new tag. | | 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`. | | 500 | The request failed for a reason on our side. `code` is `INTERNAL_ERROR`. Quote `request_id` when reporting it. |