{
  "opencollection": "1.0.0",
  "info": {
    "name": "API Endpoints subpackage_activities subpackage_comments API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "subpackage_comments",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Fetch multiple comments",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.close.com/api/v1/comment/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "thread_id",
                "value": "",
                "type": "query"
              },
              {
                "name": "object_id",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Comments may be fetched by `object_id` (the object that was commented on) or by `thread_id`. Exactly one of those filters must be provided."
        },
        {
          "info": {
            "name": "Create a Comment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.close.com/api/v1/comment/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a comment on an object. If a comment thread already exists on that object, a new comment is added to the existing thread. If no thread exists yet, one is created automatically."
        },
        {
          "info": {
            "name": "Fetch an individual comment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.close.com/api/v1/comment/:id/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Fetch an individual comment"
        },
        {
          "info": {
            "name": "Update a Comment",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.close.com/api/v1/comment/:id/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "You can use this endpoint to edit a comment body. Note that users may only update their own comments."
        },
        {
          "info": {
            "name": "Remove a comment",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.close.com/api/v1/comment/:id/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Note that contrary to the HTTP verb, this does not necessarily _delete_ a comment (but it will _remove_ it). Comments bodies are removed, but the comment object still exists until all comments in a thread are removed (at which point the entire thread is deleted).\n\nPermissions around removing comments inherit from the users permission to delete their own or other users' activities."
        },
        {
          "info": {
            "name": "Fetch multiple comment threads",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.close.com/api/v1/comment_thread/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "_limit",
                "value": "",
                "type": "query",
                "description": "Number of results to return."
              },
              {
                "name": "_skip",
                "value": "",
                "type": "query",
                "description": "Number of results to skip before returning, for pagination."
              },
              {
                "name": "ids",
                "value": "",
                "type": "query"
              },
              {
                "name": "object_ids",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Fetch multiple comment threads"
        },
        {
          "info": {
            "name": "Fetch an individual comment thread",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.close.com/api/v1/comment_thread/:id/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Fetch an individual comment thread"
        }
      ]
    }
  ],
  "bundled": true
}