Skip to main content
POST
Create comment

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>.

Path Parameters

app_id
string
required

ID of the app.

Body

application/json

A new comment thread.

content
string
required

Text of the comment, 1 to 5000 characters.

Required string length: 1 - 5000
Example:

"Make this button match the header color."

page_path
string
default:/

Path of the app page the comment is about. Defaults to /.

Maximum string length: 512
Example:

"/pricing"

anchor
CommentAnchor · object

Where to pin the thread in the app's preview. Leave it out for a thread with no pin.

screenshot_file_uri
string | null

file_uri of a screenshot uploaded to this app with Upload app file and visibility set to private. Starts with mp/private/ followed by the app's ID.

Maximum string length: 2000
Example:

"mp/private/6820f3a4e7b91d003c45a1f2/4b1e9c2a7_shot.png"

mentioned_emails
string[]

Emails of up to 50 people the comment mentions. Mentions send no notification.

Maximum array length: 50
Example:

Response

The new thread with its first comment.

A comment thread with all its comments.

thread
CommentThread · object
required

The thread's state.

comment
CommentMessage · object
required

The first comment, which started the thread.

replies
CommentMessage · object[]
required

Replies, oldest first.

Example:
reactor_names
Reactor Names · object
required

User ID mapped to name, for the people who reacted anywhere in the thread.

Example: