---
title: "Update Snippet"
method: PATCH
path: "/v3/portals/{portalId}/snippets/{snippetId}"
tags: ["Snippets"]
---

# Update Snippet

`PATCH /v3/portals/{portalId}/snippets/{snippetId}`

## Request

- Base URL: `https://global.api.konghq.com`
- URL: `https://global.api.konghq.com/v3/portals/{portalId}/snippets/{snippetId}`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer
  - HTTP bearer
  - HTTP bearer

Updates the configuration of a single custom snippet for this portal.

## Path parameters

- `portalId` string, uuid, required
- `snippetId` string, uuid, required

## Request body

- UpdatePortalSnippetRequest: Update a snippet in a portal.
  - `name` string: The unique name of a snippet in a portal.
  - `title` string: The display title of a snippet in a portal.
  - `content` string: The renderable markdown content of a page in a portal.
  - `visibility` 'public' | 'private': Whether the resource is publicly accessible to non-authenticated users.
  - `status` 'published' | 'unpublished': Whether the resource is visible on a given portal. Defaults to unpublished.
  - `description` string

## Response `200`

Details about a snippet in a portal.

- PortalSnippetResponse: Details about a snippet in a portal.
  - `id` string, uuid, required: Contains a unique identifier used for this resource.
  - `name` string, required: The unique name of a snippet in a portal.
  - `title` string: The display title of a snippet in a portal.
  - `content` string, required: The renderable markdown content of a page in a portal.
  - `visibility` 'public' | 'private', required: Whether the resource is publicly accessible to non-authenticated users.
  - `status` 'published' | 'unpublished', required: Whether the resource is visible on a given portal. Defaults to unpublished.
  - `description` string
  - `created_at` string, date-time, required: An ISO-8601 timestamp representation of entity creation date.
  - `updated_at` string, date-time, required: An ISO-8601 timestamp representation of entity update date.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found

## Changes

- **2025-11-06** `5d2b35832e3f`: 1 warning
  - added the new `type` enum value to the `allOf[subschema #2]/invalid_parameters/items/oneOf[#/components/schemas/InvalidParameterStandard]/rule` response property for the response status `400`
- **2025-10-02** `ecce2daf9de6`: 5 breaking
  - the response property `allOf[subschema #2]/invalid_parameters/items/oneOf[#/components/schemas/InvalidParameterChoiceItem]/source` became nullable for the status `400`
  - the response property `allOf[subschema #2]/invalid_parameters/items/oneOf[#/components/schemas/InvalidParameterDependentItem]/source` became nullable for the status `400`
  - the response property `allOf[subschema #2]/invalid_parameters/items/oneOf[#/components/schemas/InvalidParameterMaximumLength]/source` became nullable for the status `400`
  - the response property `allOf[subschema #2]/invalid_parameters/items/oneOf[#/components/schemas/InvalidParameterMinimumLength]/source` became nullable for the status `400`
  - …1 more

[Operation history](https://skmtc.dev/kong/apis/konnect-api-beta/changes/v3/portals/:portalId/snippets/:snippetId/patch.md)

---

[API](https://skmtc.dev/kong/apis/konnect-api-beta.md) - [All operations](https://skmtc.dev/kong/apis/konnect-api-beta/llms.txt) - [OpenAPI document](https://skmtc.dev/kong/apis/konnect-api-beta/revisions/cef0f947e9c9?raw)
