Skip to main content
POST
/
api
/
v1
/
comments
Create Comment
curl --request POST \
  --url https://api.member.dev/api/v1/comments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "attributes": {
      "body": "<string>",
      "target_id": "<string>",
      "target_type": "<string>",
      "anchor": {},
      "attachments": [
        "<string>"
      ],
      "parent_comment_id": "<string>"
    },
    "type": "<string>"
  }
}
'
{
  "data": {
    "attributes": {
      "anchor": {},
      "author_contact_id": "<string>",
      "author_display_name": "<string>",
      "body": "<string>",
      "body_plain": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "edited_at": "2023-11-07T05:31:56Z",
      "is_deleted": true,
      "parent_comment_id": "<string>",
      "reaction_count": 123,
      "reactions": [
        {}
      ],
      "target_id": "<string>",
      "target_type": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "attachments": [
        {}
      ],
      "author_photo_thumbnail_url": "<string>",
      "author_photo_thumbnail_url_expires_at": "2023-11-07T05:31:56Z",
      "author_photo_url": "<string>",
      "author_photo_url_expires_at": "2023-11-07T05:31:56Z"
    },
    "id": "<string>",
    "links": {},
    "type": "comments"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
hub_id
string
required

Body

application/vnd.api+json

Top-level envelope for POST /api/comments.

Shape: { "data": { "type": "comments", "attributes": { ... } } }

​
data
CommentCreateResource · object
required

JSON:API resource wrapper for a create request.

Response

Successful Response

Single-item JSON:API envelope for a comment.

Shape: { "data": }

​
data
CommentResource · object
required

JSON:API resource object for a comment.

Shape: { "type": "comments", "id": "", "attributes": { ... }, "links": { "self": "/api/comments/" } }