Away 11:55 PM

3 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

GroupForumPost — cloud.docs

Represents a forum post within a group's forum category.

Properties

NameTypeRequiredDescription
pathstringfalseThe resource path of the group forum post. Format: groups/{group_id}/forum-categories/{group_forum_category_id}/posts/{group_forum_post_id}
createTimestringfalseThe timestamp when the group forum post was created.
updateTimestringfalseThe timestamp when the group forum post was last updated.
pinnedbooleanfalseWhether the group forum post is pinned.
lockedbooleanfalseWhether the group forum post is locked.
groupForumPostIdstringfalseThe id of the group forum post.
titlestringfalseThe title of the group forum post.
firstComment#/components/schemas/GroupForumCommentfalseThe resource path of the group forum post's first comment, which holds the post content. By default, the first_comment field is fully populated. This will not dereference resource references within the first comment, such as GroupForumComment.author; only the path subfield of these fields will be populated. However, if only the path field of the first comment is needed, you can specify the FULL view.
authorstringfalseThe resource path of the user who created the group forum post.
archiveTimestringfalseThe timestamp when the group forum post was archived.
archiverstringfalseThe resource path of the user who archived the group forum post.
commentCountintegerfalseThe number of comments on the group forum post. This includes the first comment (post content).

Complete Schema

{
  "type": "object",
  "properties": {
    "path": {
      "example": "groups/123/forum-categories/01234567-89ab-cdef-0123-456789abcdef/posts/01234567-89ab-cdef-0123-456789abcdef",
      "type": "string",
      "description": "The resource path of the group forum post.\n\nFormat:\n`groups/{group_id}/forum-categories/{group_forum_category_id}/posts/{group_forum_post_id}`"
    },
    "createTime": {
      "readOnly": true,
      "example": "2023-07-05T12:34:56Z",
      "type": "string",
      "description": "The timestamp when the group forum post was created.",
      "format": "date-time"
    },
    "updateTime": {
      "readOnly": true,
      "example": "2023-07-05T12:34:56Z",
      "type": "string",
      "description": "The timestamp when the group forum post was last updated.",
      "format": "date-time"
    },
    "pinned": {
      "example": true,
      "type": "boolean",
      "description": "Whether the group forum post is pinned."
    },
    "locked": {
      "example": true,
      "type": "boolean",
      "description": "Whether the group forum post is locked."
    },
    "groupForumPostId": {
      "readOnly": true,
      "type": "string",
      "description": "The id of the group forum post."
    },
    "title": {
      "type": "string",
      "description": "The title of the group forum post."
    },
    "firstComment": {
      "$ref": "#/components/schemas/GroupForumComment",
      "description": "The resource path of the group forum post's first comment, which holds the\npost content.\n\nBy default, the `first_comment` field is fully populated. This **will not**\ndereference resource references within the first comment, such as\n`GroupForumComment.author`; only the `path` subfield of these fields will\nbe populated. However, if only the `path` field of the first comment is\nneeded, you can specify the FULL view."
    },
    "author": {
      "readOnly": true,
      "example": "users/156",
      "type": "string",
      "description": "The resource path of the user who created the group forum post."
    },
    "archiveTime": {
      "readOnly": true,
      "example": "2023-07-05T12:34:56Z",
      "type": "string",
      "description": "The timestamp when the group forum post was archived.",
      "format": "date-time"
    },
    "archiver": {
      "readOnly": true,
      "example": "users/156",
      "type": "string",
      "description": "The resource path of the user who archived the group forum post."
    },
    "commentCount": {
      "type": "integer",
      "description": "The number of comments on the group forum post. This includes the first\ncomment (post content).",
      "format": "int64"
    }
  },
  "description": "Represents a forum post within a group's forum category.",
  "x-aep-resource": {
    "patterns": [
      "groups/{group_id}/forum-categories/{group_forum_category_id}/posts/{group_forum_post_id}"
    ],
    "plural": "group-forum-posts",
    "singular": "group-forum-post"
  },
  "x-resource": true
}