Buttondown logo

Snippets

Routes

Listing snippetsCreating a snippetRetrieving a snippetUpdating a snippetDeleting a snippet

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">.

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!"
}

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
Example
"footer"

name

Type
string · required
Example
"Footer"

content

Type
string
Example
"Thanks for reading!"

mode

Type
Description

The editor mode for the snippet.