Forums
Forums are the main discussion area for your community. The Forums API allows you to create and moderate the content in this section.
Forum Threads API
New or Edit Object
List Object
Show Object
Forum Posts API
New or Edit Object
List Object
Show Object
Forum Threads API
List threads from forum 1000
GET /forums/100.json
Show thread 2000
GET /forum_threads/2000.json
Create new thread in forum 100
POST /forum_threads.json?forum_id=100
Update thread 2000
PATCH /forum_threads/2000.json
Delete thread 2000
DELETE /forum_threads/2000.json
Restore thread 2000
PATCH /forum_threads/2000/restore.json
Fetch list of unread threads
GET /forum_threads/unread.json
Mark all threads read
GET /forum_threads/mark_read.json
New or Edit Object
{
"forum_thread": {
"subject": "Hearthstone Beta"
}
}
List Object
{
"forum_threads": [
{
"id": 2000,
"subject": "Hearthstone Beta",
"sticky": false,
"lock": false,
"views": 500,
"forum_posts_count": 25,
"forum": {
"id": 100,
"name": "Upcoming Games",
"description": "News & Discussion for upcoming games"
}
}
]
}
Show Object
{
"forum_thread": {
"id": 2000,
"subject": "Hearthstone Beta",
"sticky": false,
"lock": false,
"views": 500,
"forum_posts_count": 25,
"forum": {
"id": 100,
"name": "Upcoming Games",
"description": "News & Discussion for upcoming games"
}
}
}
Forum Posts API
List posts from thread 400
GET /forum_threads/400.json
Show post 3000
GET /forum_posts/3000.json
Create new post in thread 400
POST /forum_posts.json?forum_thread_id=400
Update post 3000
PATCH /forum_posts/3000.json
Delete post 3000
DELETE /forum_posts/3000.json
Restore post 3000
PATCH /forum_posts/3000/restore.json
Vote up post 3000
PATCH /forum_posts/3000/vote_up.json
Vote down post 3000
PATCH /forum_posts/3000/vote_down.json
New or Edit Object
{
"forum_post": {
"message": "This game looks great!"
}
}
List Object
{
"forum_posts": [
{
"id": 3000,
"forum_thread_id": 400,
"message": "This game looks great!",
"rating": 5,
"created_on": "2013-05-15T19:30:00-05:00",
"edited_on": "",
"guest_name": "",
"member": {
"id": 4000,
"display_name": "Snafzg"
}
}
]
}
Show Object
{
"forum_post": {
"id": 3000,
"forum_thread_id": 400,
"message": "This game looks great!",
"rating": 5,
"created_on": "2013-05-15T19:30:00-05:00",
"edited_on": "",
"guest_name": "",
"member": {
"id": 4000,
"display_name": "Snafzg"
}
}
}