REST API Documentation
/forums/forums/{id}
Edit a forum
This endpoint is only available for requests made using an API Key or the Client Credentials Grant Type, not using an OAuth Access Token for a particular member.
Parameters
| Name | Type | Description |
|---|---|---|
Required
title
|
string | The forum title |
description
|
string | The forum description |
type
|
string | normal|qa|redirect|category |
parent
|
int|null | The ID number of the parent the forum should be created in. NULL for root. |
password
|
string | Forum password |
theme
|
int | Theme to use as an override |
sitemap_priority
|
int | 1-9 1 highest priority |
min_content
|
int | The minimum amount of posts to be able to view |
can_see_others
|
int | 0|1 Users can see topics posted by other users? |
permissions
|
object | An object with the keys as permission options (view, read, add, reply, attachments) and values as permissions to use (which may be * to grant access to all groups, or an array of group IDs to permit access to) |
redirect_url
|
string | If editing a redirect forum, the URL to redirect too. |
Exceptions
| Code | Message | Description |
|---|---|---|
1F363/3 |
NO_REDIRECT_URL |
No redirect URL supplied. |
1F363/4 |
INVALID_TYPE |
Invalid type of forum. |
Response
| Name | Type | Description |
|---|---|---|
id
|
int | ID number |
name
|
string | Forum name |
path
|
string | Forum name including parents (e.g. "Example Category > Example Forum") |
type
|
string | The type of forum: "discussions", "questions", "category", or "redirect" |
topics
|
int | Number of topics in forum |
url
|
string | URL |
parentId
|
int|null | Parent Node ID |
permissions
|
object|null | Node permissions |