v1

latestOpenAPI 3.0.02026-07-26254134307.1 KB

Comments

Add comment reply

Add a reply to a comment on a conversation. Comment replies visually indicate which comment is being responded to, helping users follow the conversation.

Required scope: comments:write

post/comments/{comment_id}/replies

Path parameters

comment_idstring required

The comment ID to reply to

Request body

author_idstring

ID of the teammate creating the comment. Alternatively, you can supply the author as a resource alias. If omitted, will post as the API Token or OAuth client of the requester.

bodystring required

Content of the comment. Can include markdown formatting.

is_pinnedboolean

Whether or not the comment is pinned in its conversation.

attachmentsstring[]

Binary data of attached files. Must use Content-Type: multipart/form-data if specified. See example or read more about Attachments. Max 25 MB.

Response

A comment

idstring required

Unique identifier of the comment

bodystring required

Content of the comment

posted_atnumber

The timestamp when the comment was posted

is_pinnedboolean required

Whether or not the comment is pinned in its conversation

Example response

{
  "_links": {
    "self": "https://yourCompany.api.frontapp.com/comments/com_1ywg3f2",
    "related": {
      "conversation": "https://yourCompany.api.frontapp.com/conversations/cnv_y4xb93i",
      "mentions": "https://yourCompany.api.frontapp.com/comments/com_1ywg3f2/mentions",
      "comment_replied_to": "https://yourCompany.api.frontapp.com/comments/com_1ywg3f2"
    }
  },
  "id": "com_1ywg3f2",
  "author": {
    "_links": {
      "self": "https://yourCompany.api.frontapp.com/teammates/tea_6r55a",
      "related": {
        "inboxes": "https://yourCompany.api.frontapp.com/teammates/tea_6r55a/inboxes",
        "conversations": "https://yourCompany.api.frontapp.com/teammates/tea_6r55a/conversations",
        "botSource": "https://yourCompany.api.frontapp.com/rules/rul_6r55a"
      }
    },
    "id": "tea_6r55a",
    "email": "michael.scott@dundermifflin.com",
    "username": "PrisonMike",
    "first_name": "Michael",
    "last_name": "Scott",
    "is_admin": true,
    "custom_fields": {
      "city": "London, UK",
      "isVIP": true,
      "renewal_date": 1525417200,
      "sla_time": 90,
      "owner": "leela@planet-express.com",
      "replyTo": "inb_55c8c149",
      "Job Title": "firefighter"
    }
  },
  "body": "Sometimes I'll start a sentence and I don't even know where it's going. I just hope I find it along the way.",
  "posted_at": 1698943401.378,
  "attachments": [
    {
      "id": "fil_3q8a7mby",
      "filename": "Andy_Anger_Management_Certificate.png",
      "url": "https://yourCompany.api.frontapp.com/download/fil_3q8a7mby",
      "content_type": "image/png",
      "size": 4405,
      "metadata": {
        "is_inline": true,
        "cid": "526b45586d0e6b1c484afab63d1ef0be"
      }
    }
  ],
  "is_pinned": true
}