Jump to content

Community

REST API Documentation

/forums/topics/{id}


Edit 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
forum int The ID number of the forum the topic should be created in
author int The ID number of the member creating the topic (0 for guest). Ignored for requests using an OAuth Access Token for a particular member.
author_name string If author is 0, the guest name that should be used
title string The topic title
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.
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. 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. 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 1/0 indicating if the topic should be hidden
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 bool Make the poll public
poll_only bool Make 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' (bool)

Exceptions

Code Message Description
2F294/6 INVALID_ID The topic ID does not exist or the authorized user does not have permission to view it
1F294/7 NO_FORUM The forum ID does not exist or the authorized user does not have permission to post in it
1F294/8 NO_AUTHOR The author ID does not exist
2F294/A NO_PERMISSION The authorized user does not have permission to edit the topic

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
topics int Number of topics in forum
url string URL
permissions bject|null object 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

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
ipAddress string IP address used during registration
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 tring|null object 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 atetime|null object Last activity date on the site
lastVisit atetime|null object Last distinct visit date on the site
lastPost atetime|null object 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

group object

Name Type Description
id int ID number
name string Name
formattedName string Name with formatting

fieldgroup object

Name Type Description
name string Group name
fields array of field objects Fields

field object

Name Type Description
name string Field name
value string Value

poll object

Name Type Description
id int ID number
title string Title
votes int Number of votes
questions array of question objects The questions

question object

Name Type Description
question string The question
options object Each of the options and how many votes they have had
×
×
  • Create New...