> ## Documentation Index
> Fetch the complete documentation index at: https://developers.conveyour.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a snippet

> Creates a new snippet.



## OpenAPI

````yaml /api-reference/specs/snippets.json post /api/snippets
openapi: 3.1.0
info:
  title: ConveYour API — Snippets
  description: Create and manage reusable content blocks for use in Liquid templates.
  version: 1.0.0
servers:
  - url: https://{subdomain}.conveyour.com
    description: Your organization's ConveYour instance
    variables:
      subdomain:
        default: acme
        description: >-
          Your organization's slug — the subdomain you sign in on. Replace
          `acme` with yours: if you sign in at `bigco.conveyour.com`, enter
          `bigco`.
security:
  - conveyourToken: []
tags:
  - name: Snippets
    description: Create and manage reusable content blocks for use in Liquid templates.
paths:
  /api/snippets:
    post:
      tags:
        - Snippets
      summary: Create a snippet
      description: Creates a new snippet.
      operationId: createASnippet
      parameters:
        - $ref: '#/components/parameters/teams'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - name
                - shortcut
                - content
              properties:
                name:
                  description: Human-readable name for the snippet.
                  type: string
                shortcut:
                  description: >-
                    The key used to reference this snippet in templates:
                    `snippet(legal.sms_footer)`. Use dot notation to namespace
                    snippets (e.g. `legal.sms_footer`, `program.intro`).
                  type: string
                content:
                  description: The snippet content. Supports Liquid syntax.
                  type: string
                text_content:
                  description: >-
                    Plain-text version of the content (used when the rich
                    version is HTML).
                  type: string
                notes:
                  description: Internal notes about the snippet (not sent to contacts).
                  type: string
                files:
                  description: Array of file objects to attach to the snippet.
                  type: array
                  items:
                    type: string
                folder_id:
                  description: ID of the folder to place this snippet in.
                  type: string
                order:
                  description: Sort order within the folder.
                  type: integer
            example:
              name: SMS footer
              folder_id: 64a1b2c3d4e5f6a7b8c9d0e1
              shortcut: legal.sms_footer
              content: <p>Reply STOP to opt out.</p>
              text_content: Reply STOP to opt out.
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Envelope'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/SnippetRecord'
              example:
                status: ok
                message: success
                data:
                  id: 64a1b2c3d4e5f6a7b8c9d0e1
                  name: SMS Footer
                  shortcut: legal.sms_footer
                  content: Reply STOP to opt out. Msg & data rates may apply.
        '403':
          $ref: '#/components/responses/ForbiddenToken'
components:
  parameters:
    teams:
      name: teams[]
      in: query
      description: >-
        Team scope for the request, as one or more team ObjectIds. The brackets
        are required: PHP keeps only the last value for a repeated plain key, so
        `teams=A&teams=B` silently resolves to B alone. On requests with a JSON
        body you may send `teams` (no brackets) in the body instead.


        **Values that are not valid ObjectIds are silently ignored** — a
        mistyped team ID behaves as if no team was sent. See the [teams section
        of the API conventions guide](/guides/api-conventions#team-scoping).
      style: form
      explode: true
      schema:
        type: array
        items:
          type: string
      example:
        - 64a1b2c3d4e5f6a7b8c9d0ff
  schemas:
    Envelope:
      type: object
      description: The common response envelope shared by all ConveYour endpoints.
      properties:
        status:
          type: string
          enum:
            - ok
            - failed
          description: '`ok` on success, `failed` on error.'
        message:
          type: string
          description: Human-readable description of the result.
        data:
          description: >-
            The response payload — an object or an array depending on the
            endpoint.
    SnippetRecord:
      type: object
      description: >-
        A snippet. Create, update and the HTML update return this directly, so
        it carries NO `editable` / `deletable` flags — those are computed per
        user by the read endpoints only.
      properties:
        id:
          type: string
          description: Snippet ID.
        org_id:
          type: integer
          description: Owning organization.
        user_id:
          type: integer
          description: User who created it.
        name:
          type: string
          description: Snippet name.
        shortcut:
          type: string
          description: Shortcut used to reference it, e.g. `snippet(legal.sms_footer)`.
        content:
          type: string
          description: HTML content.
        text_content:
          type: string
          description: Plain-text content.
        notes:
          type: string
          description: Internal notes.
        files:
          type: array
          description: Attached files.
        folder_id:
          type: string
          description: Containing folder.
        order:
          type: number
          description: Sort order.
        created_at:
          type: integer
          description: Unix timestamp.
        updated_at:
          type: integer
          description: Unix timestamp.
  responses:
    ForbiddenToken:
      description: >-
        The token is missing, expired, or not permitted for this HTTP method.
        **This endpoint enforces no named permission**, so a 403 here never
        carries a `permission` field.
      content:
        application/json:
          example:
            status: failed
            message: Token is either expired or does not have the correct permissions
            data: []
  securitySchemes:
    conveyourToken:
      type: apiKey
      in: header
      name: x-conveyour-token
      description: >-
        Your API key token. Contacts endpoints require a **Server-only — Full
        API** key — see [Authentication](/quickstart).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.