Buttondown logo

Creating a snippet

Create a new snippet. Each snippet must have a unique identifier within your newsletter, which is used to reference the snippet in your emails via <buttondown-snippet name="identifier">.

New to snippets? See Snippets for more on what they are and how they work in the editor.

Sample requests

These sample requests are autogenerated by the OpenAPI spec.

import requests

url = "https://api.buttondown.com/v1/snippets"
headers = {
  "Authorization": "Token $BUTTONDOWN_API_KEY"
}
data = {
  "identifier": "footer",
  "name": "Footer",
  "content": "Thanks for reading!",
  "mode": "fancy"
}

response = requests.request("POST", url, headers=headers, json=data)
print(response.text)

Sample responses

The IDs and values referenced in these responses are fake; please only rely on these responses for overall structure.

{
    "id": "snip_29fxqcmrkp969vzttksexvmvr8",
    "creation_date": "2023-01-01T00:00:00+00:00",
    "identifier": "footer",
    "name": "Footer",
    "content": "Thanks for reading!",
    "mode": "fancy",
    "reference_count": 0
}

Body parameters

All parameters are optional unless explicitly specified.

identifier

Type
string · required
Description

A unique, newsletter-scoped slug used to reference the snippet inside email content (e.g. {{ snippets.footer }}). Must be unique per newsletter.

Example
"footer"

name

Type
string · required
Description

A human-readable name for the snippet, shown in the Buttondown UI.

Example
"Footer"

content

Type
string
Description

The body of the snippet, substituted wherever the snippet is referenced. Interpreted according to mode.

Example
"Thanks for reading!"

mode

Type
SnippetMode
Description

The editor mode for the snippet, which controls how content is rendered: fancy (rich text, stored as HTML), plaintext (Markdown), or naked (raw HTML with no processing).

Example
"fancy"