Create a snippet

Create a snippet, with a name to find it by and optional dynamic variables.

Snippet name is used to find the snippet when inserting it during a reply. The text field is the plain-text body that will be used in environments that don’t render markdown. If you also pass markdown, that version is preferred wherever rich text is supported.

For TypeScript, the GraphQL SDK gives you a fully typed client for these operations.

The optional path groups snippets in the Plain app. Only alphanumeric characters are allowed.

This operation requires the following permissions:

• snippet:create

Mutation

mutation createSnippet($input: CreateSnippetInput!) {
  createSnippet(input: $input) {
    snippet {
      id
      name
      text
      markdown
      path
    }
    error {
      message
      type
      code
      fields {
        field
        message
        type
      }
    }
  }
}

Variables

{
  "input": {
    "name": "Out of office",
    "text": "Thanks for getting in touch. The team is offline right now and will get back to you within one business day.",
    "markdown": "Thanks for getting in touch. The team is offline right now and will get back to you within **one business day**.",
    "path": "general"
  }
}