REST API Documentation
/forums/topics
Create a topic
For requests using an OAuth Access Token for a particular member, any parameters the user doesn't have permission to use are ignored (for example, locked will only be honoured if the authenticated user has permission to lock topics).
Parameters
| Name | Type | Description |
|---|---|---|
Required
forum
|
int | The ID number of the forum the topic should be created in |
Required
title
|
string | The topic title |
Required
post
|
string | The post content as HTML (e.g. "<p>This is a post.</p>"). Will be sanatized for requests using an OAuth Access Token for a particular member; will be saved unaltered for requests made using an API Key or the Client Credentials Grant Type. |
author
|
int | The ID number of the member creating the topic (0 for guest). Required for requests made using an API Key or the Client Credentials Grant Type. For requests using an OAuth Access Token for a particular member, that member will always be the author |
author_name
|
string | If author is 0, the guest name that should be used |
prefix
|
string | Prefix tag |
tags
|
string | Comma-separated list of tags (do not include prefix) |
date
|
datetime | The date/time that should be used for the topic/post post date. If not provided, will use the current date/time. Ignored for requests using an OAuth Access Token for a particular member |
ip_address
|
string | The IP address that should be stored for the topic/post. If not provided, will use the IP address from the API request. Ignored for requests using an OAuth Access Token for a particular member |
locked
|
int | 1/0 indicating if the topic should be locked |
open_time
|
datetime | When the topic should be unlocked from |
close_time
|
datetime | When the topic should be locked from |
hidden
|
int | 0 = unhidden; 1 = hidden, pending moderator approval; -1 = hidden (as if hidden by a moderator) |
pinned
|
int | 1/0 indicating if the topic should be pinned |
featured
|
int | 1/0 indicating if the topic should be featured |
poll_title
|
string | Poll title (to create a poll) |
poll_public
|
int | 1/0 indicating if the poll is public |
poll_only
|
int | 1/0 indicating if this a poll-only topic |
poll_options
|
array | Array of objects with keys 'title' (string), 'answers' (array of objects with key 'value' set to the choice) and 'multichoice' (int 1/0) |
Exceptions
| Code | Message | Description |
|---|---|---|
1F294/2 |
NO_FORUM |
The forum ID does not exist |
1F294/3 |
NO_AUTHOR |
The author ID does not exist |
1F294/5 |
NO_TITLE |
No title was supplied |
1F294/4 |
NO_POST |
No post was supplied |
2F294/C |
NO_PERMISSION |
The authorized user does not have permission to create a topic in that forum |
3F294/D |
NO_ANON_PERMISSION |
The topic is set for anonymous posting, but the author does not have permission to post anonymously |
Response
| Name | Type | Description |
|---|---|---|
id
|
int | ID number |
title
|
string | Title |
forum
|
forum object | Forum |
posts
|
int | Number of posts |
views
|
int | Number of views |
prefix
|
string | The prefix tag, if there is one |
tags
|
array of strings | The tags |
firstPost
|
post object | The first post in the topic |
lastPost
|
post object | The last post in the topic |
bestAnswer
|
post object | The best answer, if this is a question and there is one |
locked
|
bool | Topic is locked |
hidden
|
bool | Topic is hidden |
pinned
|
bool | Topic is pinned |
featured
|
bool | Topic is featured |
archived
|
bool | Topic is archived |
poll
|
poll object | Poll data, if there is one |
url
|
string | URL |
rating
|
float | Average Rating |
forum object
| 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 |
post object
| Name | Type | Description |
|---|---|---|
id
|
int | ID number |
item_id
|
int | The ID number of the item this belongs to |
author
|
member object | Author |
date
|
datetime | Date |
content
|
string | The content |
hidden
|
bool | Is hidden? |
url
|
string | URL to content |
reactions
|
array | Array of reactions given, array key is member_id of reaction giver ([member_id => [ title, id, value, icon ]]) |
member object
| Name | Type | Description |
|---|---|---|
id
|
int | ID number |
name
|
string | Username |
title
|
string | Member title |
timezone
|
string | Member timezone |
formattedName
|
string | Username with group formatting |
primaryGroup
|
group object | Primary group |
secondaryGroups
|
array of group objects | Secondary groups |
email
|
string | Email address |
joined
|
datetime | Registration date |
registrationIpAddress
|
string | IP address when registered |
warningPoints
|
int | Number of active warning points |
reputationPoints
|
int | Number of reputation points |
photoUrl
|
string | URL to photo (which will be the site's default if they haven't set one) |
photoUrlIsDefault
|
bool | Indicates if the value of photoUrl is the site's default |
coverPhotoUrl
|
string | URL to profile cover photo (will be blank if there isn't one) |
profileUrl
|
string|null | URL to profile |
validating
|
bool | Whether or not the validating flag is set on the member account |
posts
|
int | Number of content item submissions member has made |
lastActivity
|
datetime|null | Last activity date on the site. |
lastVisit
|
datetime|null | Last distinct visit date on the site. |
lastPost
|
datetime|null | Latest content submission date. |
profileViews
|
int | Number of times member's profile has been viewed |
birthday
|
string | Member birthday in MM/DD/YYYY format (or MM/DD format if no year has been supplied). |
customFields
|
array of fieldgroup objects | Custom profile fields. For requests using an OAuth Access Token for a particular member, only fields the authorized user can view will be included |
rank
|
array of rank objects | Rank |
achievements_points
|
int | Points |
allowAdminEmails
|
bool | Whether or not this member wants to receive admin emails |
completed
|
bool | Whether or not the registration is completed |
group object
| Name | Type | Description |
|---|---|---|
id
|
int | ID number |
name
|
string | Name |
formattedName
|
string | Name with formatting |
rank object
| Name | Type | Description |
|---|---|---|
id
|
int | ID number |
name
|
string | Name |
url
|
string | Path to the rank icon |
points
|
int | Points |
poll object
| Name | Type | Description |
|---|---|---|
id
|
int | ID number |
title
|
string | Title |
startDate
|
datetime | Start Date |
closed
|
bool | Closed |
closedDate
|
datetime | Closed Date |
public
|
bool | Public poll |
votes
|
int | Number of votes |
questions
|
array of question objects | The questions |