Chatwoot · Schema

Category

Chatwoot Category schema

Customer SupportMessagingLive ChatOmni-channelConversationsContactsAgentsOpen Source

Properties

Name Type Description
id integer
description string The text content.
locale string
name string
slug string
position integer
portal_id integer
account_id integer
associated_category_id integer To associate similar categories to each other, e.g same category of product documentation in different languages
parent_category_id integer To define parent category, e.g product documentation has multiple level features in sales category or in engineering category.
View JSON Schema on GitHub

JSON Schema

category.json Raw ↑
{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer"
    },
    "description": {
      "type": "string",
      "description": "The text content."
    },
    "locale": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "slug": {
      "type": "string"
    },
    "position": {
      "type": "integer"
    },
    "portal_id": {
      "type": "integer"
    },
    "account_id": {
      "type": "integer"
    },
    "associated_category_id": {
      "type": "integer",
      "description": "To associate similar categories to each other, e.g same category of product documentation in different languages"
    },
    "parent_category_id": {
      "type": "integer",
      "description": "To define parent category, e.g product documentation has multiple level features in sales category or in engineering category."
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/chatwoot/main/json-schema/category.json",
  "title": "Category",
  "description": "Chatwoot Category schema"
}