Sign in

3a702c095d22

latestOpenAPI 3.1.0MIT2026-08-08133230925.7 KB
Comments

Create Comment

Create a new comment or reply to an existing comment. If subscriber_id is provided, the comment is attributed to that subscriber; otherwise it is attributed to the newsletter author.

post/comments

Request body

textstring required

The text content of the comment.

parent_idstring nullable

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

email_idstring nullable

The ID of the email this comment is for. Required if parent_id is not provided.

subscriber_idstring nullable

The ID of the subscriber to attribute the comment to. If not provided, the comment is attributed to the newsletter author.

Response

Created

idstring required

A unique TypeID associated with the object.

creation_datestring date-time required

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

email_idstring required

The ID of the email this comment is attached to.

subscriber_idstring nullable

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

parent_idstring nullable

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

textstring required

The text content of the comment.

status'pending' | 'active' | 'spammy' required

An enumeration.

Example response

{
  "subscriber": {
    "country": "US",
    "email_address": "telemachus@buttondown.email",
    "delivered_count": 12,
    "open_count": 7,
    "clicked_count": 3,
    "open_rate": 0.5833,
    "click_rate": 0.25
  },
  "email": {
    "slug": "welcome-to-the-newsletter"
  }
}