Buttondown

Buttondown integration (Marketing, Communication). Imported from open-connector.

API key12 toolshttps://api.buttondown.com/v1

GET

buttondown_get_account

Get the account associated with the Buttondown API key.

/accounts/me

GET

buttondown_list_newsletters

List newsletters available to the Buttondown API key.

/newsletters/{page}

2 parameters

Param	Type	Required	Description
page	integer	required	The 1-based page number of the paginated response.
page_size	integer	optional	The number of results per page.

GET

buttondown_list_subscribers

List Buttondown subscribers with common filters.

/subscribers/{page}

6 parameters

Param	Type	Required	Description
page	integer	required	The 1-based page number of the paginated response.
email_address	string	optional	Only return subscribers matching this email fragment.
type	string	optional	The subscriber lifecycle state returned by Buttondown.
tag	array	optional	Only return subscribers matching the given tag names.
date__start	string	optional	Only return subscribers created on or after the given date.
date__end	string	optional	Only return subscribers created before the given date.

GET

buttondown_get_subscriber

Retrieve one Buttondown subscriber by ID or email address.

/subscribers/{id_or_email}

1 parameter

Param	Type	Required	Description
id_or_email	string	required	The Buttondown subscriber ID or email address.

POST

buttondown_create_subscriber

Create a Buttondown subscriber.

/subscribers

12 parameters

Param	Type	Required	Description
email_address	string	required	The email address of the subscriber.
notes	string	optional	Any private notes to attach to the subscriber.
metadata	object	optional	A structured key-value blob stored on the Buttondown object.
tags	array	optional	Tag names to apply to the subscriber. Tags that do not already exist will be cr…
referrer_url	string	optional	The URL the subscriber was referred from.
utm_campaign	string	optional	The UTM campaign attributed to the subscriber.
utm_medium	string	optional	The UTM medium attributed to the subscriber.
utm_source	string	optional	The UTM source attributed to the subscriber.
type	string	optional	—
ip_address	string	optional	—
collision_behavior	string	optional	Behavior to apply when a record with the same value exists.
bypass_firewall	boolean	optional	Whether to bypass Buttondown's firewall for this subscriber creation.

PATCH

buttondown_update_subscriber

Update a Buttondown subscriber by ID or email address.

/subscribers/{id_or_email}

9 parameters

Param	Type	Required	Description
id_or_email	string	required	The Buttondown subscriber ID or email address.
commenting_disabled	boolean	optional	—
email_address	string	optional	—
notes	string	optional	—
metadata	object	optional	—
tags	array	optional	—
referrer_url	string	optional	—
type	string	optional	—
unsubscription_reason	string	optional	—

DELETE

buttondown_delete_subscriber

Delete a Buttondown subscriber by ID or email address.

/subscribers/{id_or_email}

1 parameter

Param	Type	Required	Description
id_or_email	string	required	The Buttondown subscriber ID or email address.

GET

buttondown_list_tags

List Buttondown tags.

/tags/{page}

2 parameters

Param	Type	Required	Description
page	integer	required	The 1-based page number of the paginated response.
page_size	integer	optional	The number of results per page.

POST

buttondown_create_tag

Create a Buttondown tag.

/tags

6 parameters

Param	Type	Required	Description
name	string	required	The name of the tag.
color	string	required	The hex color code associated with the tag.
description	string	optional	—
public_description	string	optional	—
subscriber_editable	boolean	optional	Whether subscribers can add or remove this tag from their own profile.
collision_behavior	string	optional	Whether to overwrite an existing tag with the same name.

GET

buttondown_get_tag

Retrieve one Buttondown tag by ID.

/tags/{id}

1 parameter

Param	Type	Required	Description
id	string	required	The Buttondown tag ID.

PATCH

buttondown_update_tag

Update a Buttondown tag by ID.

/tags/{id}

7 parameters

Param	Type	Required	Description
id	string	required	The Buttondown tag ID.
name	string	optional	—
color	string	optional	—
description	string	optional	—
public_description	string	optional	—
secondary_id	integer	optional	—
subscriber_editable	boolean	optional	—

DELETE

buttondown_delete_tag

Delete a Buttondown tag by ID.

/tags/{id}

1 parameter

Param	Type	Required	Description
id	string	required	The Buttondown tag ID.