Skip to main content

Updates a category

PUT 

/categories/:id.json

Updates a category

Request

Path Parameters

    id integerrequired

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

success response

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
Loading...