Table of Contents

• 01. Record field format
• 02. Associated attributes
• 03. Nomenclature
• 04. Index
• 05. Show
• 06. Create
• 07. Update
• 08. Delete
• 09. Undelete
• 10. See also
• 11. External links

The following includes the details of how to interface with the forum post records through the API.

Record field format

Name	Type	Details
id	integer	>0
topic_id	integer	>0
body	string
is_deleted	boolean
creator_id	integer	>0
updater_id	integer	>0
created_at	timestamp
updated_at	timestamp

Associated attributes

Name	Type	Number	Availability	Details
creator	user	single	required	User that created the forum post.
updater	user	single	required	User that last updated the forum post.
topic	forum topic	single	required	Forum topic the forum post is on.
dtext_links	dtext link	multiple	optional	Dtext links on the forum post.
votes	forum post vote	multiple	optional	Any votes the forum post may have.
tag alias	tag alias	multiple	optional	Tag aliases linked to the forum post.
tag implication	tag implication	multiple	optional	Tag implications linked to the forum post.
bulk update request	bulk update request	multiple	optional	Bulk update requests linked to the forum post.

Nomenclature

• Plural form: "forum_posts"
• Used in the URL pathname
• Singular form: "forum_post"
• Used for write parameters (Help:API Write Requests)
• Versions: none

Index

HTTP Method	GET or POST*
Base URL	/forum_posts.json
Type	read request
Description	The default order is updated at descending. * Accepts POST under certain circumstances. See Help:API read requests.

Search attributes

All of the following are standard attributes with all of their available formats and qualifiers.

• Number syntax
• id
• topic_id
• created_at
• updated_at
• Text syntax
• body
• User syntax
• creator
• updater
• Boolean syntax
• is_deleted
• Chaining syntax
• topic
• dtext_links
• votes
• tag alias
• tag implication
• bulk update request

Special search parameters

• body_matches - Case-insensitive wildcard searching on the body text field.
• topic_title_matches - Case-insensitive wildcard searching on the topic title the forum post is on.
• topic_category_id - Can be: 0, 1, 2 (General, Tags, Bugs & Features respectively).
• linked_to - Shows forum posts that link to a particular wiki.
• The parameter must use the same format as the wiki title
• I.e. all lowercase and underscores instead of spaces

Search order

The search order is not configurable with a search parameter. However, the order can still be changed to ID descending by using sequential pagination.

Show

HTTP Method	GET or POST*
Base URL	/forum_posts/$id.json
Type	read request
Description	$id is the forum post ID. * Accepts POST under certain circumstances. See Help:API read requests.

Create

HTTP Method	POST
Base URL	/forum_posts.json
Type	write request
Description

Create parameters

• Required:
• body
• topic_id

Update

HTTP Method	PUT/PATCH
Base URL	/forum_posts/$id.json
Type	write request
Description	$id is the forum post ID.

Update parameters

• Optional:
• body

Delete

HTTP Method	DELETE
Base URL	/forum_posts/$id.json
Type	write request
Description	$id is the forum post ID. Restricted to Moderator+.

Undelete

HTTP Method	POST
Base URL	/forum_posts/$id/undelete.json
Type	write request
Description	$id is the forum post ID. Restricted to Moderator+.

See also

• Help:Common URL Parameters
• Help:API

External links

Controller	https://github.com/danbooru/danbooru/blob/master/app/controllers/forum_posts_controller.rb
Model	https://github.com/danbooru/danbooru/blob/master/app/models/forum_post.rb
Policy	https://github.com/danbooru/danbooru/blob/master/app/policies/forum_post_policy.rb

View wiki