---
title: "CreatePortalSnippetRequest"
url: "https://nov18-dev.movespot.fyi/apis/portal-management-v3-3/versions/209d0e93-97b5-4dd3-a5a4-172ba6d8a51e/schemas/CreatePortalSnippetRequest"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/portal-management-v3-3/versions/209d0e93-97b5-4dd3-a5a4-172ba6d8a51e.md

# CreatePortalSnippetRequest

Create a snippet in a portal.

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Portal Management V3
  version: 3.4.1
servers:
  - url: https://us.api.konghq.com/v3
    description: United-States Production region
  - url: https://eu.api.konghq.com/v3
    description: Europe Production region
  - url: https://au.api.konghq.com/v3
    description: Australia Production region
  - url: https://me.api.konghq.com/v3
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v3
    description: India Production region
  - url: https://sg.api.konghq.com/v3
    description: Singapore Production region
components:
  schemas:
    SnippetName:
      description: The unique name of a snippet in a portal.
      type: string
      example: my-snippet
      maxLength: 512
      title: SnippetName
    SnippetTitle:
      description: The display title of a snippet in a portal.
      type: string
      example: My Snippet
      maxLength: 512
      title: SnippetTitle
    SnippetContent:
      description: The renderable markdown content of a page in a portal.
      type: string
      example: "# Welcome to My Snippet"
      maxLength: 1000000
      title: SnippetContent
    SnippetVisibilityStatus:
      description: >
        Whether a snippet is publicly accessible to non-authenticated users.

        If not provided, the default_page_visibility value of the portal will be
        used.
      type: string
      example: public
      enum:
        - public
        - private
      title: PageVisibilityStatus
    PublishedStatus:
      description: Whether the resource is visible on a given portal. Defaults to
        unpublished.
      type: string
      example: published
      enum:
        - published
        - unpublished
      title: PublishedStatus
    Description:
      type: string
      example: A custom page about developer portals
      maxLength: 160
      title: ResourceDescription
    CreatePortalSnippetRequest:
      description: Create a snippet in a portal.
      type: object
      properties:
        name:
          $ref: "#/components/schemas/SnippetName"
        title:
          $ref: "#/components/schemas/SnippetTitle"
        content:
          $ref: "#/components/schemas/SnippetContent"
        visibility:
          $ref: "#/components/schemas/SnippetVisibilityStatus"
        status:
          $ref: "#/components/schemas/PublishedStatus"
        description:
          $ref: "#/components/schemas/Description"
      additionalProperties: false
      required:
        - name
        - content
      title: CreatePortalSnippetRequest
```
