Edit a post. Edits a post's title, Markdown body or category (null removes it; categories come from the post's board). Only fields you pass change. Authors edit their own posts; managers and owners edit any. Pass expected_version from get_post to avoid overwriting someone else's edit. Status changes use change_post_status instead. Nobody is emailed.
Toolset
core
Who can call it
OwnersManagersContributorsCustomersAPI keys
REST
PATCH /api/v1/w/{workspace}/posts/{post}
Behavior
changes dataidempotent
Input
Field
Type
Description
postrequired
string
The post's ID (pst_…) or slug (the last part of its portal URL).
title
string
body
string
Markdown. Raw HTML is shown as text, not rendered.
category
string or null
Category name, slug or ID on the post's board; null to remove it.
attachment_ids
array of string
The post's full attachment list after the edit, in order: new uploads are added, omitted ones removed. Leave out to keep them as they are.
fields
object
Custom field values by key (list_custom_fields). Customers can set only the fields on the board's form; null clears a value.
expected_version
integer
The post's version from your last read. If it changed since, the call fails instead of overwriting a newer change.
Output
Field
Type
Description
idrequired
string
ID with prefix "pst_"
workspace_idrequired
string
ID with prefix "ws_"
slugrequired
string
titlerequired
string
boardrequired
object
categoryrequired
object or null
statusrequired
object
authorrequired
object
moderation_staterequired
one of: approved, pending, rejected, spam
Only approved posts are shown to end users other than the author.
ownerrequired
object or null
The responsible team member; null when unassigned, and always for end users.
etarequired
object or null
tagsrequired
array of object or null
Internal tags; null for end users, who never see tags.
merged_intorequired
object or null
Set when merged into another post: this one is read-only and redirects there.
vote_countrequired
integer
comment_countrequired
integer
Public comments and replies.
voted_by_yourequired
boolean or null
Whether you have voted on it; null unless you're an end user.
shipped_inrequired
object or null
The published changelog entry that announced it, if any.
followed_by_yourequired
boolean or null
Whether you follow it (follow / unfollow); null for API keys and visitors.
emailable_followersrequired
integer or null
How many customers a status change with notify emails: followers who can be emailed and keep post updates on. Team only (null for customers and visitors).
status_changed_atrequired
string (date-time)
last_activity_atrequired
string (date-time)
versionrequired
integer
created_atrequired
string (date-time)
updated_atrequired
string (date-time)
portal_urlrequired
string (uri)
admin_urlrequired
string (uri) or null
Admin inbox link; null for end users.
bodyrequired
string
Markdown, as written.
attachmentsrequired
array of object
In the order they were attached.
created_by_member_idrequired
string or null
The member who posted on the author's behalf; null otherwise or for end users.
fieldsrequired
object
Custom field values by key; customers see public fields only.
roadmapsrequired
array of object or null
Internal roadmaps it's on (team only; null for customers).
mrr_at_stakerequired
number or null
Summed MRR of the distinct companies of its voters (team only).