Skip to main content
PATCH
Update forum post

Yetkilendirmeler

Authorization
string
header
gerekli

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Yol Parametreleri

id
string
gerekli

The unique identifier of the forum post to update.

Gövde

application/json

Parameters for UpdateForumPost

attachments
FileInputWithId · object[] | null

A replacement list of file attachments for this post, such as images or videos.

content
string | null

The updated body of the post in Markdown format. For example, 'Check out this update'. Hidden if the post is paywalled and the viewer has not purchased access.

is_pinned
boolean | null

Whether this post should be pinned to the top of the forum. Only top-level posts can be pinned, not comments.

title
string | null

The updated title of the post, displayed prominently at the top. Required for paywalled posts as it remains visible to non-purchasers.

visibility
enum<string> | null

Controls who can see this forum post, such as members only or public.

Mevcut seçenekler:
members_only,
globally_visible

Yanıt

A successful response

A post or comment in a forum feed, supporting rich text, attachments, polls, and reactions.

attachments
object[]
gerekli

All file attachments on this post, such as images, documents, and videos.

comment_count
integer
gerekli

The total number of direct comments on this post.

Örnek:

42

content
string | null
gerekli

The body of the forum post in Markdown format. Null if the post is paywalled and the current user does not have access.

Örnek:

"## My Strategy\n\nHere are the key steps..."

created_at
string<date-time>
gerekli

The time this post was created, as a Unix timestamp.

Örnek:

"2023-12-01T05:00:00.401Z"

id
string
gerekli

Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "VXNlci0xMA==") or integer (such as 4) input value will be accepted as an ID.

is_edited
boolean
gerekli

Whether this post has been edited after its initial creation.

is_pinned
boolean
gerekli

Whether this post is pinned to the top of the forum feed.

is_poster_admin
boolean
gerekli

Whether the author of this post is an admin of the company that owns the forum.

like_count
integer | null
gerekli

The total number of like reactions this post has received.

Örnek:

42

parent_id
string | null
gerekli

The unique identifier of the parent post. Null if this is a top-level post.

title
string | null
gerekli

The headline of the forum post. Null if the post has no title.

Örnek:

"Weekly Market Analysis - February 2025"

updated_at
string<date-time>
gerekli

The time this post was last updated, as a Unix timestamp.

Örnek:

"2023-12-01T05:00:00.401Z"

user
object
gerekli

The user who authored this forum post.

view_count
integer | null
gerekli

The total number of times this post has been viewed by users.

Örnek:

42