POST/spaces/api/v1/spaces/{spaceID}/pages/{pageID}/comments.json

create a comment

Path Params

  • Name
    spaceID
    Type
    integer
    required
    Description
  • Name
    pageID
    Type
    integer
    required
    Description

Body Params

    • Name
      comment
      Type
      object
      Description
      CommentCreate is an object to use when creating a new comment.

    Responses

    • Code
      200
      Type
      object
      Schema
      Description
      200 OK
    • Code
      400
      Type
      object
      Schema
      Description
      400 Bad Request
    • Code
      404
      Type
      object
      Schema
      Description
      404 Not Found
    • Code
      500
      Type
      object
      Schema
      Description
      500 Internal Server Error

    Examples

    200 OK

    Comment
    {
      "comment": {
        "content": "string",
        "createdAt": "2024-07-25T17:16:47.171Z",
        "createdBy": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "deletedAt": "2024-07-25T17:16:47.171Z",
        "deletedBy": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "id": 0,
        "identifier": "string",
        "isPrivate": true,
        "page": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "parentId": 0,
        "reactions": {
          "counts": {},
          "userReactionId": 0
        },
        "selection": "string",
        "space": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "state": "string",
        "updatedAt": "2024-07-25T17:16:47.171Z",
        "updatedBy": {
          "id": 0,
          "meta": {},
          "type": "string"
        }
      }
    }