Log in or sign up for an account

Comment

Comments are a way for subscribers to interact with newsletters. They're a way to provide feedback, ask questions, and generally engage with the content of an email. Comments exist in a tree structure; comments that reply to other comments are considered "children" of the parent comment.

Basic comment

{
    "creation_date": "2019-08-24T14:15:22Z",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "subscriber_id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "email_id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "body": "I really liked this email!",
    "parent_id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
fieldtypedescription
idstring
email_idstring
subscriber_idstring
parent_idstring
textstring
creation_datestring
subscriberSubscriber

List Comments

curl
python
ruby
typescript
Copy to clipboard
import requests
headers = {
    "Authorization": f"Token {BUTTONDOWN_API_KEY}",
}


BASE_URL = "https://api.buttondown.email"
ENDPOINT = "/v1/comments"


response = requests.get(f"{BASE_URL}{ENDPOINT}", headers=headers)

Parameters

parametertypedescriptionoptional
email_idstring

If provided, only return comments for the given email.

subscriber_idstring

If provided, only return comments for the given subscriber.

expandstring

If provided, expand the given field. (Only supported field: 'subscriber').

orderingunknown

Responses

StatusDescriptionSample Response
200OK
{
    "results": [
        {
            "creation_date": "2019-08-24T14:15:22Z",
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "subscriber_id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "email_id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "body": "I really liked this email!",
            "parent_id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        }
    ],
    "count": 1
}
403Forbidden
{
    "code": "something_went_wrong",
    "detail": "Your call is very important to us."
}
409Conflict
{}