A valid request URL is required to generate request examples{
"post": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"slug": "<string>",
"body_markdown": "<string>",
"published": true,
"published_at": "2023-11-07T05:31:56Z",
"segment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"feedback_post_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Edit a changelog post
Requires engagement:manage. Partial: an absent field is left alone.
published_at is not editable here. Publishing is its own act, and a typo fix must not be able to flip it by omission — nor to un-publish, since the document it went into is cacheable and a copy may already be somewhere.
segment_id: null widens the post back out to everybody, which on a published post moves it into the public document. That is allowed and it is one-way in practice: a post aimed at the wrong audience is a mistake you have to be able to fix, and the alternative — delete and rewrite — loses the read state of everybody who already saw it.
A valid request URL is required to generate request examples{
"post": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"slug": "<string>",
"body_markdown": "<string>",
"published": true,
"published_at": "2023-11-07T05:31:56Z",
"segment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"feedback_post_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Authorizations
A staff session token, uk_st_…. Minted by sign-up, sign-in or the two-factor exchange. Only a 401 means it is spent; not_a_member (403) is about the organization named in X-Organization-Id and leaves the token good for the others.
Headers
The organization the caller is acting on — the org_… code that appears in the panel URL. It identifies; the membership JOIN is what authorizes, so a forged code reads nothing: the answer is not_a_member (403), which does not mean the session is over. Absent, the session's default organization answers, or — if that membership was revoked while the session was open — any other one the caller still holds.
Path Parameters
Body
200100000Optional, and it MOVES the page: every link already sent to the old address stops working. Changing title deliberately does not come here — a typo fix in a headline is not a reason to break a permalink. 409 if another post in the environment holds it.
200null clears the audience — everybody, and on a published post that means the public document.
The other audience: the people who voted for that feedback post. Setting it CLEARS segment_id in the same statement — a post has at most one audience, and two calls would leave a window with none, which on this table means everybody. null clears it.
Response
The post.
One release note. Written as a draft, aimed at a segment or at everybody, and published by an act of its own — published_at is a moment rather than a flag, because the list is ordered by it and the unread badge compares a contact's arrival against it.
Show child attributes
Show child attributes