Publish article

Propose publishing an article, or updating its published copy to the page as it is now. It always waits for a person to approve it in Olamma, and needs public pages to be on.

POST/v1/w/{workspace}/help-articles/{articleId}/publish

Send an Idempotency-Key. This may answer 202 while it waits for approval.

Path parameters

workspacestringrequired

Your workspace’s address name.

articleIdstringrequired

The article to publish.

Headers

Idempotency-Keystring

8–100 characters. Repeat the same key and body to get the first outcome back instead of writing twice.

Response

statusobjectrequired

approvalIdstringrequired

Details

Propose publishing a help article. A person decides using the workspace publishing rules.

Since 2026-12. Errors are listed in Errors.

cURL

curl -X POST "https://api.olamma.sh/v1/w/your-workspace/help-articles/{articleId}/publish" \
  -H "Authorization: Bearer $OLAMMA_KEY" \
  -H "Idempotency-Key: <unique key>"

Response 202

{
  "status": "awaiting_approval",
  "approvalId": "<string>"
}