Update a snippet

Change a snippet’s name, text, or group using field-level wrapper inputs.

Updates use field-level wrapper inputs: to change a field pass { "value": ... }; to leave a field untouched omit it entirely. To clear the path (un-group a snippet) pass { "value": null }.

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

This operation requires the following permissions:

• snippet:edit

Mutation

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

Variables

{
  "input": {
    "snippetId": "sn_01HXXXXXXXXXXXXXXXXXXXXXXX",
    "name": { "value": "Out of office (updated)" },
    "text": { "value": "Thanks for getting in touch! We'll reply within one business day." }
  }
}