Forum Topics

An alias for /forum_topics exists: /ftopics (hide, unhide, mark_all_as_read, subscribe, and ubsuscribe routes are not supported).

Search Forum Topics

GET https://e621.net/forum_topics.json

Moderator+ Required To search hidden forum topics not created by the authenticated user.

Some topics may be in specific categories that require certain user levels to view.

Query Parameters

Name	Type	Description
search[title_matches]	String	The title of the forum topic (fuzzy matching).
search[title]	String	The title of the forum topic (exact matching).
search[category_id]	Number	The ID of the category the forum topic is in.
search[is_hidden]	Boolean	If the forum topic is hidden.
search[is_locked]	Boolean	If the forum topic is locked.
search[is_sticky]	Boolean	If the forum topic is sticky.
search[order]	String	The order of the returned results. One of: sticky
search[id]	Number	See Search Parameters: search[id]
limit	Number	See Search Parameters: limit
page	String	See Search Parameters: page

200: OK Success (Results)

[
  {
    "category_id": 0,
    "created_at": "0000-00-00T00:00:00.000-00:00",
    "creator_id": 0,
    "id": 0,
    "is_hidden": false,
    "is_locked": false,
    "is_sticky": false,
    "response_count": 0,
    "title": "",
    "updated_at": "0000-00-00T00:00:00.000-00:00",
    "updater_id": 0
  }
]

200: OK Success (No Results)

[]

Get Forum Topic

GET https://e621.net/forum_topics/{id}.json

Moderator+ Required If the forum topic is hidden, and not created by the authenticated user.

Some topics may be in specific categories that require certain user levels to view.

Path Parameters

Name	Type	Description
id*	Number	The ID of the forum topic.

200: OK Success

{
  "category_id": 0,
  "created_at": "0000-00-00T00:00:00.000-00:00",
  "creator_id": 0,
  "id": 0,
  "is_hidden": false,
  "is_locked": false,
  "is_sticky": false,
  "response_count": 0,
  "title": "",
  "updated_at": "0000-00-00T00:00:00.000-00:00",
  "updater_id": 0
}

403: Forbidden Access Denied

{
  "success": false,
  "reason": "Access Denied"
}

404: Not Found Not Found

{
  "success": false,
  "reason": "not found"
}

Hide Forum Topic

POST https://e621.net/forum_topics/{id}/hide.json

Authorization Required

Moderator+ Required If the forum topic is not yours.

This operation is idempotent.

Path Parameters

Name	Type	Description
id*	Number	The ID of the forum topic to hide.

201: Created Success

{
  "category_id": 0,
  "created_at": "0000-00-00T00:00:00.000-00:00",
  "creator_id": 0,
  "id": 0,
  "is_hidden": false,
  "is_locked": false,
  "is_sticky": false,
  "response_count": 0,
  "title": "",
  "updated_at": "0000-00-00T00:00:00.000-00:00",
  "updater_id": 0
}

403: Forbidden Access Denied

{
  "success": false,
  "reason": "Access Denied"
}

404: Not Found Not Found

{
  "success": false,
  "reason": "not found"
}

Unhide Forum Topic

POST https://e621.net/forum_topics/{id}/unhide.json

Authorization Required

Moderator+ Required

This operation is idempotent.

Path Parameters

Name	Type	Description
id*	Number	The ID of the forum topic to unhide.

201: Created Success

{
  "category_id": 0,
  "created_at": "0000-00-00T00:00:00.000-00:00",
  "creator_id": 0,
  "id": 0,
  "is_hidden": false,
  "is_locked": false,
  "is_sticky": false,
  "response_count": 0,
  "title": "",
  "updated_at": "0000-00-00T00:00:00.000-00:00",
  "updater_id": 0
}

403: Forbidden Access Denied

{
  "success": false,
  "reason": "Access Denied"
}

404: Not Found Not Found

{
  "success": false,
  "reason": "not found"
}

Subscribe To Forum Topic

POST https://e621.net/forum_topics/{id}/subscribe.json

Authorization Required

Some topics may be in specific categories that require certain user levels to view.

This operation is idempotent.

Path Parameters

Name	Type	Description
id*	Number	The ID of the forum topic to subscribe to.

201: Created Success

{
  "category_id": 0,
  "created_at": "0000-00-00T00:00:00.000-00:00",
  "creator_id": 0,
  "id": 0,
  "is_hidden": false,
  "is_locked": false,
  "is_sticky": false,
  "response_count": 0,
  "title": "",
  "updated_at": "0000-00-00T00:00:00.000-00:00",
  "updater_id": 0
}

403: Forbidden Access Denied

{
  "success": false,
  "reason": "Access Denied"
}

404: Not Found Not Found

{
  "success": false,
  "reason": "not found"
}

Unubscribe From Forum Topic

POST https://e621.net/forum_topics/{id}/subscribe.json

Authorization Required

Some topics may be in specific categories that require certain user levels to view.

This operation is idempotent.

Path Parameters

Name	Type	Description
id*	Number	The ID of the forum topic to unsubscribe from.

201: Created Success

{
  "category_id": 0,
  "created_at": "0000-00-00T00:00:00.000-00:00",
  "creator_id": 0,
  "id": 0,
  "is_hidden": false,
  "is_locked": false,
  "is_sticky": false,
  "response_count": 0,
  "title": "",
  "updated_at": "0000-00-00T00:00:00.000-00:00",
  "updater_id": 0
}

403: Forbidden Access Denied

{
  "success": false,
  "reason": "Access Denied"
}

404: Not Found Not Found

{
  "success": false,
  "reason": "not found"
}

Mark All Forum Topics As Read

POST https://e621.net/forum_topics/mark_all_as_read.json

Authorization Required

302: Found Success

<html><body>You are being <a href="https://e621.net/forum_topics">redirected</a>.</body></html>

Create Forum Topic

POST https://e621.net/forum_topics.json

Authorization Required

Some topics may be in specific categories that require certain user levels to create topics.

Request Body

Name	Type	Description
forum_topic[title]	String	The title of the forum topic.
forum_topic[category_id]	Number	The ID of the category the forum topic is in.
forum_topic[is_sticky]	Number	If the forum topic is sticky. Moderator+ Required
forum_topic[is_locked]	Number	If the forum topic is locked. Moderator+ Required
forum_topic[original_post_attributes][body]	String	The body of the first post in the topic. Mutually exclusive with forum_topic[original_post_attributes][id].
forum_topic[original_post_attributes][id]	Boolean	IThe ID of the post to use as the first post of this topic. Mutually exclusive with forum_topic[original_post_attributes][body].

201: Created Success

{
  "body": "",
  "created_at": "0000-00-00T00:00:00.000-00:00",
  "creator_id": 0,
  "id": 0,
  "is_hidden": false,
  "topic_id": 0,
  "updated_at": "0000-00-00T00:00:00.000-00:00",
  "updater_id": 0,
  "warning_type": null, // warning, record, ban
  "warning_user_id": null
}

403: Forbidden Access Denied

{
  "success": false,
  "reason": "Access Denied"
}

422: Unprocessable Entity Account Too New

{
  "errors": {
    "original_post.creator": [
      "can not yet perform this action. Account is too new"
    ]
  }
}

422: Unprocessable Entity Invalid Original Post

{
  "errors": {
    "original_post": [
      "is invalid"
    ]
  }
}

422: Unprocessable Entity Restricted Topic

{
  "errors": {
    "original_post.topic": [
      "is restricted",
      "does not allow replies"
    ]
  }
}

422: Unprocessable Entity Restricted Category

{
  "errors": {
    "category": [
      "does not allow new topics"
    ]
  }
}

422: Unprocessable Entity Blank Original Post

{
  "errors": {
    "original_post": [
      "can't be blank"
    ]
  }
}

500: Internal Server Error Invalid Category

{
  "success": false,
  "message": "An unexpected error occurred.",
  "code": "00000000-0000-0000-0000-000000000000"
}

422: Unprocessable Entity Title Too Long

{
  "errors": {
    "title": [
      "is too long (maximum is 250 characters)"
    ]
  }
}

422: Unprocessable Entity Original Post Body Too Long

{
  "errors": {
    "original_post.body": [
      "is too long (maximum is 50000 characters)"
    ]
  }
}

Edit Forum Topic

PATCH https://e621.net/forum_topics/{id}.json

Authorization Required

Admin+ Required If the forum topic is not yours.

Path Parameters

Name	Type	Description
id*	Number	The ID of the forum topic to edit.

Request Body

Name	Type	Description
forum_post[body]	String	The body of the forum post.

204: No Content Success

403: Forbidden Access Denied

{
  "success": false,
  "reason": "Access Denied"
}

404: Not Found Not Found

{
  "success": false,
  "reason": "not found"
}

422: Unprocessable Entity Blank Body

{
  "errors": {
    "body": [
      "can't be blank",
      "is too short (minimum is 1 character"
    ]
  }
}

422: Unprocessable Entity Body Too Long

{
  "errors": {
    "body": [
      "is too long (maximum is 50000 characters)"
    ]
  }
}

Delete Forum Post

DELETE https://e621.net/forum_posts/{id}.json

Authorization Required

Admin+ Required

204: No Content Success

403: Forbidden Access Denied

{
  "success": false,
  "reason": "Access Denied"
}

404: Not Found Not Found

{
  "success": false,
  "reason": "not found"
}

Create Forum Post Vote

POST https://e621.net/forum_posts/{id}/votes.json

Authorization Required

Janitor+ Required If account is less than 3 days old.

Votes can only be added to posts which are the OP of an alias request, implication request, or bulk update request.

Access denied error messages can be combined, separated by a semicolon and space (; ).

Path Parameters

Name	Type	Description
id*	Number	The ID of the forum post to vote on.

Request Body

Name	Type	Description
forum_post_vote[score]*	Number	The vote to cast. One of: -1, 0, 1.

201: Created Success

{
  "created_at": "0000-00-00T00:00:00.000-00:00",
  "creator_id": 0,
  "creator_name": "",
  "forum_post_id": 0,
  "id": 0,
  "score": 0, // 1, 0, -1
  "updated_at": "0000-00-00T00:00:00.000-00:00"
}

403: Forbidden Access Denied

{
  "success": false,
  "reason": "Access Denied"
}

403: Forbidden Account Too New

{
  "success": false,
  "reason": "Access Denied: Creator can not yet perform this action. Account is too new"
}

403: Forbidden Invalid Score

{
  "success": false,
  "reason": "Access Denied: Score is not included in the list"
}

403: Forbidden Cannot Vote On Own Post

{
  "success": false,
  "reason": "Access Denied: You cannot vote on your own requests"
}

404: Not Found Not Found

{
  "success": false,
  "reason": "not found"
}

Delete Forum Post Vote

DELETE https://e621.net/forum_posts/{id}/votes.json

Authorization Required

Path Parameters

Name	Type	Description
id*	Number	The ID of the forum post to delete the vote on.

200: OK Success

{}

403: Forbidden Access Denied

{
  "success": false,
  "reason": "Access Denied"
}

404: Not Found Not Found

{
  "success": false,
  "reason": "not found"
}