Updates a category

PUT 
/categories/:id.json

Updates a category

Request

Path Parameters

id integerrequired

application/json

Body

name stringrequired
color stringrequired
text_color stringrequired
parent_category_id integerrequired
allow_badges booleanrequired
slug stringrequired
topic_featured_links_allowed booleanrequired
permissions object
everyone integerrequired
staff integerrequired
property name* anyrequired
search_priority integerrequired
form_template_ids undefined[]required

Responses

200

success response

application/json

Schema

Schema

success stringrequired
category objectrequired
id integerrequired
name stringrequired
color stringrequired
text_color stringrequired
slug stringrequired
topic_count integerrequired
post_count integerrequired
position integerrequired
description stringnullrequired
description_text stringnullrequired
description_excerpt stringnullrequired
topic_url stringnullrequired
read_restricted booleanrequired
permission integernullrequired
notification_level integerrequired
can_edit booleanrequired
topic_template stringnullrequired
form_template_ids undefined[]required
has_children booleannullrequired
subcategory_count integernullrequired
sort_order stringnullrequired
sort_ascending stringnullrequired
show_subcategory_list booleanrequired
num_featured_topics integerrequired
default_view stringnullrequired
subcategory_list_style stringrequired
default_top_period stringrequired
default_list_filter stringrequired
minimum_required_tags integerrequired
navigate_to_first_post_after_read booleanrequired
custom_fields objectrequired
allowed_tags undefined[]required
allowed_tag_groups undefined[]required
allow_global_tags booleanrequired
required_tag_groups object[]required
Array [
name stringrequired
min_count integerrequired
]
category_setting required
read_only_banner stringnullrequired
available_groups undefined[]required
auto_close_hours stringnullrequired
auto_close_based_on_last_post booleanrequired
allow_unlimited_owner_edits_on_first_post booleanrequired
default_slow_mode_seconds stringnullrequired
group_permissions object[]required
Array [
permission_type integerrequired
group_name stringrequired
]
email_in stringnullrequired
email_in_allow_strangers booleanrequired
mailinglist_mirror booleanrequired
all_topics_wiki booleanrequired
can_delete booleanrequired
allow_badges booleanrequired
topic_featured_link_allowed booleanrequired
search_priority integerrequired
uploaded_logo stringnullrequired
uploaded_logo_dark stringnullrequired
uploaded_background stringnullrequired
uploaded_background_dark stringnullrequired

Example (from schema)

{
  "success": "string",
  "category": {
    "id": 0,
    "name": "string",
    "color": "string",
    "text_color": "string",
    "slug": "string",
    "topic_count": 0,
    "post_count": 0,
    "position": 0,
    "read_restricted": true,
    "notification_level": 0,
    "can_edit": true,
    "form_template_ids": [
      null
    ],
    "show_subcategory_list": true,
    "num_featured_topics": 0,
    "subcategory_list_style": "string",
    "default_top_period": "string",
    "default_list_filter": "string",
    "minimum_required_tags": 0,
    "navigate_to_first_post_after_read": true,
    "custom_fields": {},
    "allowed_tags": [
      null
    ],
    "allowed_tag_groups": [
      null
    ],
    "allow_global_tags": true,
    "required_tag_groups": [
      {
        "name": "string",
        "min_count": 0
      }
    ],
    "available_groups": [
      null
    ],
    "auto_close_based_on_last_post": true,
    "allow_unlimited_owner_edits_on_first_post": true,
    "group_permissions": [
      {
        "permission_type": 0,
        "group_name": "string"
      }
    ],
    "email_in_allow_strangers": true,
    "mailinglist_mirror": true,
    "all_topics_wiki": true,
    "can_delete": true,
    "allow_badges": true,
    "topic_featured_link_allowed": true,
    "search_priority": 0
  }
}

Loading...