Edit post

Update an existing post. Only the post author or admins can edit. Supports updating body, references, mentions, draft status, and room visibility settings.

Path Parameters

id number required

Unique numeric post ID to update

application/json

Request Body required

Partial post data to update - only include fields to change

roomPostStatus number

Possible values: [0, 1, 2]

The room post status, defaults to publicly: 1. As Room: 0, Publicly: 1, Only Members: 2

body string

Possible values: >= 6 characters

draft boolean
references object[]
Array [
chapterId number required
Possible values: >= 1
from number required
Default value: 0
to number required
Default value: 0
]
mentions object[]
Array [
marker string required
Possible values: Value must match regular expression /{{[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}}}/
userId string required
displayName string required
]
roomId number
postAsAuthorId string
publishedAt date-time

Responses

• 200
• 401
• 403
• 404

---

Post updated successfully with the updated post data

application/json

Schema

Example (from schema)

---

Schema

post object required
tags object[]
Array [
language string
id number required
name string
]
references object[]
Array [
id string required
from number
to number
chapterId number
]
author object
recentComment object
id number required
author object required
postsCount number
avatarUrls object required
small string
medium string
large string
id string required
username string
verified boolean
Default value: false
firstName string
lastName string
memberType number
body string required
createdAt date-time required
room object nullable
isAdmin object
isOwner object
isPublic object
id number required
subdomain string
roomType string
verified boolean
Default value: false
name string
_group string
mentions object[]
Array [
postsCount number
avatarUrls object required
small string
medium string
large string
id string required
username string
verified boolean
Default value: false
firstName string
lastName string
memberType number
locations object required
followersCount number required
displayName string
]
isLiked boolean
isByFollowedUser boolean
isCommentedOn boolean
isSaved boolean
id number required
authorId string required
body string
discussionId number
draft boolean
Default value: false
createdAt date-time required
updatedAt date-time required
publishedAt date-time
global boolean
toxicityScore number
reported boolean
Default value: false
views number
removed boolean
Default value: false
verified boolean
Default value: false
roomPostStatus number
Possible values: [0, 1, 2]
Default value: 0
@description 0: OnlyMembers, 1: Publicly, 2: AsRoom
hidden boolean
Default value: false
commentsCount number required
Default value: 0
likesCount number
Default value: 0
viewsCount number
Default value: 0
languageId number
languageName string
moderationStatus number
Possible values: [1, 2, 3, 4, 5, 6, 30]
featured = 1, // Like Sticky posts, will be featured for a time period.Shown at top in feed and partner apps
promoted = 2, // High quality content.Shown at top(after featured) in feed and partner apps
normal = 3, // Default status, available in search, latest and popular tabs.In feed(if you're following the author)
hidden = 4, // Visible only to author or moderators, or via private share link.
private_note = 5, // Private notes, only visible to author or via private share link.These are the posts made "private" by moderators.
requested_review = 6, // User requested the review, treat them has hidden.Only visible to author and moderators
deleted = 30,
reviewedAt date-time
featuredAt date-time
estimatedReadingTime number
Default value: 0
roomId number required
postTypeId number required
postTypeName string
success boolean required

{
  "post": {
    "tags": [
      {
        "language": "string",
        "id": 0,
        "name": "string"
      }
    ],
    "references": [
      {
        "id": "string",
        "from": 0,
        "to": 0,
        "chapterId": 0
      }
    ],
    "author": {},
    "recentComment": {
      "id": 0,
      "author": {
        "postsCount": 0,
        "avatarUrls": {
          "small": "string",
          "medium": "string",
          "large": "string"
        },
        "id": "string",
        "username": "string",
        "verified": false,
        "firstName": "string",
        "lastName": "string",
        "memberType": 0
      },
      "body": "string",
      "createdAt": "2025-12-03T13:05:32.647Z"
    },
    "room": {
      "isAdmin": {},
      "isOwner": {},
      "isPublic": {},
      "id": 0,
      "subdomain": "string",
      "roomType": "string",
      "verified": false,
      "name": "string",
      "_group": "string"
    },
    "mentions": [
      {
        "postsCount": 0,
        "avatarUrls": {
          "small": "string",
          "medium": "string",
          "large": "string"
        },
        "id": "string",
        "username": "string",
        "verified": false,
        "firstName": "string",
        "lastName": "string",
        "memberType": 0,
        "locations": {},
        "followersCount": 0,
        "displayName": "string"
      }
    ],
    "isLiked": true,
    "isByFollowedUser": true,
    "isCommentedOn": true,
    "isSaved": true,
    "id": 0,
    "authorId": "string",
    "body": "string",
    "discussionId": 0,
    "draft": false,
    "createdAt": "2025-12-03T13:05:32.647Z",
    "updatedAt": "2025-12-03T13:05:32.647Z",
    "publishedAt": "2025-12-03T13:05:32.647Z",
    "global": true,
    "toxicityScore": 0,
    "reported": false,
    "views": 0,
    "removed": false,
    "verified": false,
    "roomPostStatus": 0,
    "hidden": false,
    "commentsCount": 0,
    "likesCount": 0,
    "viewsCount": 0,
    "languageId": 0,
    "languageName": "string",
    "moderationStatus": 1,
    "reviewedAt": "2025-12-03T13:05:32.647Z",
    "featuredAt": "2025-12-03T13:05:32.647Z",
    "estimatedReadingTime": 0,
    "roomId": 0,
    "postTypeId": 0,
    "postTypeName": "string"
  },
  "success": true
}

User not authenticated

User not authorized to edit this post

Post not found

Loading...