Update a forum.

Resource url

https://Your project.userecho.com/api/v2/forums.json

Parameters

Parameter Value Required? Default Options Description
id Integer yes Forum ID.
name String no Forum name.
type String no PUBLIC PUBLIC, PRIVATE, KNOWLEDGEBASE PUBLIC, KNOWLEDGEBASE PRIVATE Forum type.
locale String no en en, ru, es, fr, de, nl, is, et, kk, pt-br, uk, cs, da, fi, hu, it, ja, ko, sv, tr, zh-hans, ca, pl, lv, lt, nb, he, ar Forum default language.
allow_anonymous_topic Boolean no false Allow anonymous topics.
allow_anonymous_votes Boolean no false Allow anonymous voting.
allow_anonymous_comments Boolean no false Allow anonymous comments.
allow_private_sso_users Boolean no false Allow to open for any SSO users.
allow_private_view_all Boolean no false If current forum is private, allow all users to view it in readonly mode.

Request example #1

{
    "id": 1,
    "name": "Fresh forum",
}

Request example #2

{
    "id": 1,
    "name": "Fresh forum",
    "type": "PUBLIC",
    "allow_anonymous_topic": false,
    "allow_anonymous_votes": true,
    "allow_anonymous_comments": false
}

Response example

{
    "id": 1,
    "name": "Fresh forum",
    "vote_count": 0,
    "type": {
        "id": 1,
        "name": "PUBLIC"
    },
    "is_default": false,
    "allow_anonymous_topic": true,
    "created": "2014-03-13T21:10:51.253Z",
    "comment_count": 0,
    "topic_count": 0
}