Buttondown logo

Introduction

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.

{
    "id": "com_0k28edc3fw896bp4mrhc535z5k",
    "creation_date": "2020-09-29T00:00:00+00:00",
    "email_id": "em_5jrfaebxn7bdp9t3gz58xmrqbe",
    "subscriber_id": "sub_63tkjzd9xrdhygw7sa7d65tvkz",
    "parent_id": null,
    "text": "This is a test comment",
    "status": "active",
    "subscriber": null,
    "email": null
}

Fields

id

Type
string
Description

A unique TypeID associated with the object.

creation_date

Type
string
Description

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

email_id

Type
string
Description

The ID of the email this comment is attached to.

subscriber_id

Type
string
Description

The ID of the subscriber who posted the comment, or null if posted by the newsletter author.

parent_id

Type
string
Description

The ID of the parent comment, if this comment is a reply to another comment.

text

Type
string
Description

The text content of the comment.

status

Type
CommentStatus
Description

The moderation status of the comment (e.g. active, spammy).

subscriber

Type
Subscriber

email

Type
Email