Publish Docs article

Publish the draft of a Docs article, or unpublish the article.

POST https://cotlet.dev/api/v1/help-scout/articles/{article_id}/docs-article/publish

write Confirm

With action publish, puts the draft live on your public Docs site, as Update does on a published article, and the draft is deleted. With unpublish, removes the article from the site without deleting its content. Readers and search engines see the change at once. Discarded drafts cannot be restored. By default you confirm each call; you can switch that off for this tool.

Parameters

Parameters: publish_docs_article
NameTypeDescription
article_id string required string Article ID from search_docs_articles.
action enum required enum publish or unpublish.

Request

cURL
curl -X POST https://cotlet.dev/api/v1/help-scout/articles/article_8c41d2/docs-article/publish \
  -H "Authorization: Bearer $COTLET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"action":"publish"}'
Python
result = client.call("help-scout", "publish_docs_article", {"article_id":"article_8c41d2","action":"publish"})
Node.js
const result = await cotlet.call('help-scout', 'publish_docs_article', {"article_id":"article_8c41d2","action":"publish"});
CLI
cotlet call help-scout publish_docs_article --data '{"article_id":"article_8c41d2","action":"publish"}'

Example response

JSON

{
  "article_id": "6628f1a2b5d30",
  "status": "published",
  "has_draft": false
}

Sign in once. Your agent does the rest.

Sign up and add the apps you need. Free 7-day trial with 2,000 credits, no card needed.