Knowledge Library: Category

Path /{category-id}

Represents a Knowledge Library category. The /{category-id} node returns a single category.

Reading

You can read information about a category by making a Graph API GET request to /{category-id}.

Permissions

Reading Category node require Read Knowledge Library content permission.

Fields

Publishing

You can't publish using this node. To make a new category in a community, use the /community/knowledge_library_categories edge as described here.

Deleting

A category can be deleted by making a DELETE request to /{category_id}. You will need Manage Knowledge Library content permission.

Updating

A category can be updated by making a POST request on the /{category_id}. You will need Manage Knowledge Library content permission.

Edges

Examples

Get the title, icon, color, json_content of a category

GET /{category_id}?fields=title,icon,color,json_content HTTP/1.1
        Host: graph.facebook.com

Publish a subcategory

POST /{category_id}/subcategories?
        title={...} &
        json_content={...}
        icon ={...}

        HTTP/1.1
        Host: graph.facebook.com

Get the audience of a category, including details on whether it was shared with groups, specific users or based on profile set conditions

GET /{category_id}?
        fields=read_audience
        {audience_type, 
        groups,
        static_users,
        profile_set_conditions}

        HTTP/1.1
        Host: graph.facebook.com

Set the audience of a category

POST /{category_id} HTTP/1.1
        Host: graph.facebook.com

 Payload:
 
  //Example 1:
 {
   "read_audience": {
        "audience_type": "PROFILE_FIELDS",
        "profile_set_conditions": [
            {
                "field": "LOCATION",
                "operator": "CONTAINS",
                "values": [
                    "London",
                    "San Francisco"
                ]
            },
            {
               "field": "TITLE",
                "operator": "CONTAINS",
                "values": [
                    "Engineer"
                ]
            }
        ]
    }
}
 
  //Example 2:
  {
 "read_audience": {
        "audience_type": "GROUPS",
        "groups": [{group_id_1},{group_id_2}]
    }
}
  
  //Example 3:
  //Only for subcategories to inherit the parent category's audience
 {
   "read_audience": {
        "audience_type": "INHERIT" 
    }
}

Upload a new photo (via url) to a category:

POST graph.facebook.com
        /{category-id}/photos?url={image-url}

Upload a new video (via url) to a category:

POST graph.facebook.com
        /{category-id}/videos?url={video-url}

Upload a new file(via url) to a category:

POST graph.facebook.com
        /{category-id}/files?url={file-url}&name={file_name}

Get the comments for a category

Get /{category_id}/comments?
        summary=true

        HTTP/1.1
        Host: graph.facebook.com

Get the reactions for a category

Get /{category_id}/reactions?
        summary=true&
        since={unix_timestamp}&
        until={unix_timestamp}

        HTTP/1.1
        Host: graph.facebook.com

Deleting a category

DELETE /{category_id} HTTP/1.1
        Host: graph.facebook.com

Supported JSON Content Syntax

json_content

 {
  "json_content": [
    {
      "type": {root_type},
    }
  ],
}

json_content[]

Root Type Example: Text Block

 {
      "type": "text_block",
      "children": [
        {
          "type": "h1",
          "children": [
            {
              "type": "text",
              "text": "Header 1"
            }
          ]
        },
        {
          "type": "p",
          "children": [
            {
              "type": "text",
              "text": "This is a paragraph"
            }
          ]
        },
      ]
    }

Root Type Example: Image

{
      "type": "image",
      "image_data": {
        "id": {image_id}
      },
      "image_width": 440,
      "halign": "center"
    }

Root Type Example: Video

 {
      "type": "video",
      "video_data": {
        "id": {video_id}
      },
      "is_gif": false
    }

Root Type Example: Resource Section

{
	"type": "resource_section",
	"name": {section_name},
	"children": [{
			"type": "resource_file",
			"file_data": {
				"id": {file_id}
			},
			"name": {file_name},
			"description": {file_description}
		},
		{
			"type": "resource_link",
			"href": {file_url},
			"name": {file_name},
			"description": {file_description}
		}
	]
}}
  

Root Type Example: Embedded Media

 {
      "type": "embedded_media",
      "url": {url}
    }

json_content[].children[]

code

Examples

• Mention

 {
	"type": "mention",
	"children": [{
		"type": "text",
		"text": "Mentioned Member"
	}],
	"created_by": {
		"id":{creator_member_id},
		"name": "Creator Member"
	},
	"entity": {
		"id": {mentioned_member_id},
		"name": "Mentioned Member"
	}
}

• Formatted Text

 {
 	"type": "p",
 	"children": [{
 		"type": "b",
 		"children": [{
 			"type": "i",
 			"children": [{
 				"type": "u",
 				"children": [{
 					"type": "text",
 					"text": "Example Content which is Bold, Italics & Underlined"
 				}]
 			}]
 		}]
 	}]
 }

• Numbered List

 {
 	"type": "ol",
 	"children": [{
 			"type": "li",
 			"children": [{
 				"type": "text",
 				"text": "Item 1"
 			}]
 		},
 		{
 			"type": "li",
 			"children": [{
 				"type": "text",
 				"text": "Item 2"
 			}]
 		}
 	]
 }

• Code

{
	"type": "code",
	"children": [{
		"type": "b",
		"children": [{
			"type": "text",
			"text": "console.log(\"Bold\")"
		}]
	}]
}

• Hyperlink

 {
	"type": "a",
	"children": [{
		"type": "text",
		"text": {link_text}
	}],
	"href": {url}
}