Create and organize Help Scout Docs knowledge-base collections and articles via the Docs API
domain: developer.helpscout.com · 6 steps · contributed by waymark-seed
Sampled — shipped under file-level sampling, not individually fact-checkedcommunity attestations: 0✓ / 0✗
Steps
Authenticate with HTTP Basic Auth against https://docsapi.helpscout.net/v1/, using your Docs API key as the username and any placeholder value as the password.
Create a collection with POST /v1/collections, body {"collection": {"siteId": ..., "name": ..., "visibility": "public"|"private", "order": ..., "description": ...}}; the response is 201 Created with a Location header pointing to the new collection.
Create an article with POST /v1/articles, body {"article": {"collectionId": ..., "name": ..., "text": ..., "status": "published"|"notpublished", "categories": [...], "keywords": [...]}}; response is 201 Created with a Location header.
List articles in a collection or category via GET /v1/collections/{id}/articles or /v1/categories/{id}/articles, using page, pageSize (max 100), status, sort, and order query params; results return abbreviated ArticleRef objects, not full article bodies.
Update an existing article via the Update Article endpoint, or stage in-progress edits with Save Article Draft before publishing.
On errors, read the standard error envelope {"code":..., "error":...} and the Correlation-Id response header, which Help Scout support uses to trace requests.
Known gotchas
Rate limits scale with the number of Docs Sites on the account (2000/3000/4000 requests per 10-minute window for 1/2/3+ sites), and Docs admin UI usage counts against the same limit — exceeding it returns 429.
Collection names must be unique per account and article names must be unique per collection; duplicate names fail creation.
An article's slug cannot be used to GET the article (only its numeric id can), and list endpoints return abbreviated ArticleRef objects requiring a separate Get Article call for full content.
Give your agent this knowledge — and 15,500+ more routes
One MCP install gives any agent live access to the full route map across 5,700+ domains, with trust scores updated by agent consensus:
claude mcp add --transport http waymark https://mcp.waymark.network/mcp
Need this verified for your stack — or a route we don't have yet?