A valid request URL is required to generate request examples{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"collection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"published_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"latest_version": 123,
"latest_title": "<string>",
"published_version": 123,
"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"
}
}Publish a version
Requires support:write. Points the public page at the named version — publishing is a pointer move, so it cannot half-land, and the previous version keeps answering until the move commits. version_id is required on purpose: “publish the latest” would put whatever somebody last saved on the public site, unfinished drafts included.
Publishes help_article.published (deliverable), carrying slug and version and never the body — a cache or search index hears the page changed and fetches it from the public endpoint.
A valid request URL is required to generate request examples{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"collection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"published_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"latest_version": 123,
"latest_title": "<string>",
"published_version": 123,
"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"
}
}Autorizações
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.
Cabeçalhos
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.
Parâmetros de caminho
Corpo
The version whose words go public. Must belong to this article.
Resposta
The article, now published at this version.
An article's identity: slug, collection, and the pointer to whichever version is public. The words live in versions — published_version_id null is a draft, invisible on every public surface.
The public URL segment, unique per organization case-insensitively.
Which version the public page reads. Null is a draft.
The newest version's number — what the editor opens. Present on list and create responses.
The newest version's title. Present on list and create responses.
The published version's number, on list responses. Null is a draft.