Buttondown Documentation

Buttondown Documentation

© 2016–2025 Buttondown LLC.

TwitterGitHubLinkedInMastodonBlueskyFacebook

Introduction

You will likely not need to interact with your newsletter settings programmatically, but if you do, this is the endpoint for you. You can create, update, and list newsletters via the API; this is ideal for integrating with Buttondown as a headless email or newsletter provider (e.g. for a SaaS product.)

{
    "api_key": "7f819f8f-8220-4dcd-b7e3-37c81ead8b7a",
    "creation_date": "2019-08-24T14:15:22Z",
    "description": "I write about corgis and Python and lifting and all sorts of stuff!",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "Justin's neat newsletter",
    "username": "jmduke",
    "footer": "Thanks, as always, for reading!",
    "header": "Howdy, gang!",
    "tint_color": "#0069FF",
    "from_name": "Justin Duke"
}

Fields

id

Type
string

username

Type
string

name

Type
string

description

Type
string
Description

A brief description of your newsletter

creation_date

Type
string
Description

The date and time at which the object was first created.

api_key

Type
string

tint_color

Type
string

from_name

Type
string
Type
string
Type
string

domain

Type
string

email_domain

Type
string

enabled_features

Type
array

custom_email_template

Type
string

css

Type
string
Description

Custom CSS styling for your newsletter emails

web_css

Type
string
Description

Custom CSS styling for your newsletter's web presence

icon

Type
string
Description

URL to your newsletter's icon image

image

Type
string
Description

URL to your newsletter's header or branding image

auditing_mode

Type
NewsletterAuditingMode
Description

The auditing mode for your newsletter. See the Firewall for more information.

custom_churn_email_subject

Type
string
Description

Custom subject line for churn emails

custom_churn_email_body

Type
string
Description

Custom body content for churn emails

custom_churn_email_template

Type
string
Description

Custom template for churn emails

test_mode

Type
boolean
Description

Whether test mode is enabled for this newsletter

© 2016–2025 Buttondown LLC.

TwitterGitHubLinkedInMastodonBlueskyFacebook