---
title: "Create Snippet"
method: POST
path: "/v3/portals/{portalId}/snippets"
tags: ["Snippets"]
---

# Create Snippet

`POST /v3/portals/{portalId}/snippets`

## Request

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

Creates a new custom snippet for this portal. Custom snippets can be used to display static content, documentation, or other information to developers. Title and Description properties may be provided in the frontmatter section of `content`. If you set values in both the `POST` request _and_ in the frontmatter, the values in the frontmatter will take precedence.

## Path parameters

- `portalId` string, uuid, required

## Request body

- CreatePortalSnippetRequest: Create a snippet in a portal.
  - `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': Whether a snippet is publicly accessible to non-authenticated users. If not provided, the default_page_visibility value of the portal will be used.
  - `status` 'published' | 'unpublished': Whether the resource is visible on a given portal. Defaults to unpublished.
  - `description` string

## Response `201`

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
- **2025-08-12** `b2800570b3e2`: 1 breaking, 3 info
  - request property `visibility` was restricted to a list of enum values
  - the `visibility` request property default value `private` was removed
  - added the new `private` enum value to the request property `visibility`
  - added the new `public` enum value to the request property `visibility`
- **2025-04-28** `d12b4edfb67b`: 1 info
  - the request property `title` became optional

[Operation history](https://skmtc.dev/kong/apis/konnect-api-beta/changes/v3/portals/:portalId/snippets/post.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)