{
  "opencollection": "1.0.0",
  "info": {
    "name": "Helpcenter CommunityTopic API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "CommunityTopic",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Unmoderate community topic",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/communityTopics/:topicId/unmoderate",
            "params": [
              {
                "name": "topicId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API helps unmoderate a forum topic, which means user comments are published without reviewing."
        },
        {
          "info": {
            "name": "List forum topics",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/communityTopics",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of topics to list"
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "Index number, starting from which the topics must be listed"
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "Type of topics to list. Values allowed are: @ANNOUNCEMENT@, @DISCUSSION@, @IDEA@, @PROBLEM@, and @QUESTION@."
              },
              {
                "name": "tagName",
                "value": "",
                "type": "query",
                "description": "Tag by which topics must be filtered"
              },
              {
                "name": "isSticky",
                "value": "",
                "type": "query",
                "description": "Key that defines whether the topics to list must be sticky posts or not"
              }
            ]
          },
          "docs": "This API lists a particular number of forum topics, based on the limit defined."
        },
        {
          "info": {
            "name": "Add community topic",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/communityTopics",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API helps add a forum topic in the user community. "
        },
        {
          "info": {
            "name": "Permanently delete trashed community topics",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/api/v1/communityTopics",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API permanently deletes forum topics from the trash."
        },
        {
          "info": {
            "name": "Associate tags to community topic",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/communityTopics/:topicId/associateTags",
            "params": [
              {
                "name": "topicId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API associates quick access/reference tags to a forum topic."
        },
        {
          "info": {
            "name": "Approve topics",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/communityTopics/approve",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API helps to approve topics and publish them on the forum."
        },
        {
          "info": {
            "name": "Report topic as spam",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/communityTopics/:topicId/markSpam",
            "params": [
              {
                "name": "topicId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API marks a forum topic as spam."
        },
        {
          "info": {
            "name": "Update Drafted Topic",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/api/v1/communityTopics/:topicId/updateDraft",
            "params": [
              {
                "name": "topicId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API helps update the draft of a forum topic."
        },
        {
          "info": {
            "name": "Get topic",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/communityTopics/:topicId",
            "params": [
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Additional information related to the topics. Values allowed are: @seo@, @featuredImage@ and @participantsCount@."
              },
              {
                "name": "topicId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API fetches a forum topic from the user community."
        },
        {
          "info": {
            "name": "Update community topic",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/api/v1/communityTopics/:topicId",
            "params": [
              {
                "name": "topicId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API helps update a published forum topic."
        },
        {
          "info": {
            "name": "Delete drafted community topic",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/api/v1/communityTopics/:topicId/deleteDraft",
            "params": [
              {
                "name": "topicId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API deletes a topic draft from the user community."
        },
        {
          "info": {
            "name": "List all community topic followers",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/communityTopics/:topicId/followers",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of users to list"
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "Index number, starting from which the users must be listed."
              },
              {
                "name": "userType",
                "value": "",
                "type": "query",
                "description": "Filters based on the type of the user who follows it. The allowed values are @AGENT@ or @END_USER@."
              },
              {
                "name": "topicId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API lists a particular number of users who follow a forum topic, based on the limit defined. "
        },
        {
          "info": {
            "name": "Dissociate tags from topic",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/communityTopics/:topicId/dissociateTags",
            "params": [
              {
                "name": "topicId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API removes quick access/reference tags from a forum topic."
        },
        {
          "info": {
            "name": "Unmoderate community topics",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/communityTopics/unmoderate",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API unmoderate the moderated forum topics.The comments that are posted during moderation will be displayed to all users without under going any review."
        },
        {
          "info": {
            "name": "Report multiple topics as spam",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/community/markAllTopicsAsSpam",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API marks multiple forum topics as spam."
        },
        {
          "info": {
            "name": "Unlock community topic",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/communityTopics/:topicId/unlock",
            "params": [
              {
                "name": "topicId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API helps unlock a forum topic, so that further user actions can be performed."
        },
        {
          "info": {
            "name": "Draft community topic",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/communityTopics/saveDraft",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API saves a draft of a forum topic."
        },
        {
          "info": {
            "name": "List topics pending moderation",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/communityModeration/topics",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of topics to list"
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "Index number, starting from which the topics must be listed"
              },
              {
                "name": "categoryId",
                "value": "",
                "type": "query",
                "description": "ID of the community category from which the topics must be fetched"
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Moderation status of the topics. Values allowed are: @AWAITINGAPPROVAL@, @SPAM@, and @TRASHED@."
              }
            ]
          },
          "docs": "This API lists a particular number of forum topics that are pending moderation, based on the limit defined."
        },
        {
          "info": {
            "name": "List topic participants",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/communityTopics/:topicId/participants",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of users to list"
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "Index number, starting from which the users must be listed"
              },
              {
                "name": "userType",
                "value": "",
                "type": "query",
                "description": "Filters based on the type of the user who follows it. The allowed values are @AGENT@ or @END_USER@."
              },
              {
                "name": "topicId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API lists a particular number of users who participated in a forum topic, based on the limit defined."
        },
        {
          "info": {
            "name": "Unfollow community topic",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/communityTopics/:topicId/unfollow",
            "params": [
              {
                "name": "topicId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API enables users to unfollow a topic."
        },
        {
          "info": {
            "name": "Trash unmoderated community topics",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/communityTopics/moveToTrash",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API trashes forum topics that are yet to be moderated for publishing. "
        },
        {
          "info": {
            "name": "Get community Topics Views Count",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/communityTopics/count",
            "params": [
              {
                "name": "viewId",
                "value": "",
                "type": "query",
                "description": "ID of a view for which you need to get the count"
              },
              {
                "name": "label",
                "value": "",
                "type": "query",
                "description": "Status label by which topics must be filtered. The value of this key varies according to the topic type. Values allowed are: @NOSTATUS@, @NEEDMOREINFO@, @WORKINGONIT@, @ANSWERED@, @UNANSWERED@, @MAYBELATER@, @UNDERREVIEW@, @IMPLEMENTED@, @WILLNOTIMPLEMENT@, @NOTAPROBLEM@, @TEMPORARYFIX@, @ANALYZING@, @SOLVED@, @UNSOLVED@, and @MOSTVOTED@."
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "Type of topics to list. Values allowed are: @ANNOUNCEMENT@, @DISCUSSION@, @IDEA@, @PROBLEM@, and @QUESTION@."
              },
              {
                "name": "tagName",
                "value": "",
                "type": "query",
                "description": "Tag by which topics must be filtered"
              },
              {
                "name": "categoryId",
                "value": "",
                "type": "query",
                "description": "ID of the community category from which the topics must be fetched"
              }
            ]
          },
          "docs": "This API fetches the total count of the topics based on the selected view."
        },
        {
          "info": {
            "name": "Unlike topic",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/communityTopics/:topicId/unlike",
            "params": [
              {
                "name": "topicId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API enables users to unlike a topic."
        },
        {
          "info": {
            "name": "Get topic types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/communityTopicTypes"
          },
          "docs": "This API fetches the topic types defined in the user community of your help desk portal."
        },
        {
          "info": {
            "name": "Update topic type preferences",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/api/v1/communityTopicTypes",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API helps set the default topic type and enable/disable other topic types in the user community."
        },
        {
          "info": {
            "name": "Follow community topic",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/communityTopics/:topicId/follow",
            "params": [
              {
                "name": "topicId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API enables users to follow a topic."
        },
        {
          "info": {
            "name": "Moderate community topic",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/communityTopics/:topicId/moderate",
            "params": [
              {
                "name": "topicId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API allows to set the forum topics as moderate. The comments that are posted during moderation will not be displayed to users and await for the review."
        },
        {
          "info": {
            "name": "Move a community topic",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/communityTopics/:topicId/move",
            "params": [
              {
                "name": "topicId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API moves a forum topic from one community category to another."
        },
        {
          "info": {
            "name": "Get community topic by permalink",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/communityTopicByPermalink",
            "params": [
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Additional information related to the topics. Values allowed are: @seo@, @featuredImage@ and @participantsCount@."
              },
              {
                "name": "permalink",
                "value": "",
                "type": "query",
                "description": "permalink of the topic"
              }
            ]
          },
          "docs": "This API fetches a forum topic, based on the permalink in the API request."
        },
        {
          "info": {
            "name": "Restore trashed topics",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/communityTopics/restore",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API restores topics from trash. "
        },
        {
          "info": {
            "name": "List moderated community topics",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/communityModeratedTopics",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of topics to list"
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "Index number, starting from which the topics must be listed"
              },
              {
                "name": "categoryId",
                "value": "",
                "type": "query",
                "description": "ID of the community category from which the topics must be fetched"
              }
            ]
          },
          "docs": "This API lists a particular number of moderated topics, based on the limit defined."
        },
        {
          "info": {
            "name": "List community topics by user",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/communityUsers/:userId/topics",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of topics to list"
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "Index number, starting from which the topics must be listed"
              },
              {
                "name": "startTime",
                "value": "",
                "type": "query",
                "description": "Starting time of the time range in which the topics should have been created. The value must be expressed according to the GMT time zone."
              },
              {
                "name": "endTime",
                "value": "",
                "type": "query",
                "description": "Ending time of the time range in which the topics should have been created. The value must be expressed according to the GMT time zone."
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "Type of topics to list. Values allowed are: @ANNOUNCEMENT@, @DISCUSSION@, @IDEA@, @PROBLEM@, and @QUESTION@."
              },
              {
                "name": "categoryId",
                "value": "",
                "type": "query",
                "description": "ID of the community category from which the topics must be fetched"
              },
              {
                "name": "userId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API lists a particular number of topics by a user, based on the limit defined."
        },
        {
          "info": {
            "name": "List community topic voters",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/communityTopics/:topicId/voters",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of users to list"
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "Index number, starting from which the users must be listed"
              },
              {
                "name": "userType",
                "value": "",
                "type": "query",
                "description": "Filters based on the type of the user who follows it. The allowed values are @AGENT@ or @END_USER@."
              },
              {
                "name": "topicId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API lists a particular number of users who voted in a forum topic, based on the limit defined."
        },
        {
          "info": {
            "name": "Like community topic",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/communityTopics/:topicId/like",
            "params": [
              {
                "name": "topicId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API enables users to like a topic."
        },
        {
          "info": {
            "name": "List all Drafted community Topics",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/communityMyDraftedTopics",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of topics to list"
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "Index number, starting from which the topics must be listed"
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "Type of topics to list. Values allowed are: @ANNOUNCEMENT@, @DISCUSSION@, @IDEA@, @PROBLEM@, and @QUESTION@."
              },
              {
                "name": "categoryId",
                "value": "",
                "type": "query",
                "description": "ID of the community category from which the topics must be fetched"
              }
            ]
          },
          "docs": "This API List all Drafted Topics of the current User"
        },
        {
          "info": {
            "name": "Publish community topic draft",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/communityTopics/:topicId/publishDraft",
            "params": [
              {
                "name": "topicId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API publishes the draft of a forum topic."
        }
      ]
    }
  ],
  "bundled": true
}