Buttondown Documentation

Buttondown Documentation

© 2016–2024 Buttondown LLC.

TwitterDiscord GitHubLinkedInMastodonBlueskyFacebook

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

creation_date

Type
string

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

© 2016–2024 Buttondown LLC.

TwitterDiscord GitHubLinkedInMastodonBlueskyFacebook