Publish an article's working copy
Example request
Generated- cURL
- JavaScript
- TypeScript
- Python
- PHP
- Go
- Java
- Ruby
- C#
Responses
Releases the article’s pending working copy as the live version, so what readers see becomes the draft that was waiting. Working copies are per-language, so this publishes one language per call.
Prefer this over updating the article with working_copy omitted. An ordinary update to a published article also releases whatever working copy was pending, as a side effect of writing the live version, which is rarely what a caller editing one field intends.
Returns 404 when the language has no working copy, so a client is never told it published something that was not there.
Authentication
-
-
ApiKeyBearerhttpbearerAn API key sent as
Authorization: Bearer <key>. A key holds scopes, the same ones OAuth uses, and an operation needs the scope listed for it under OAuth2. A key may also expire, or be revoked or rotated in Settings > API, after which it is refused with a 401.
-
-
-
OAuth2oauth2An OAuth 2.0 access token for an app acting on behalf of a HelpDocs user, sent as
Authorization: Bearer <token>. The authorization code flow requires PKCE (S256). Each operation names the one scope it needs.
-
Path parameters
-
article_idstring Required
Query parameters
-
language_codestringPublish the working copy of this translation. Defaults to the account’s default language.
Responses
The article as it now reads
application/json
ArticleResponse
Authentication failed or no API key was supplied.
application/json
Error
An error response.
-
codeinteger RequiredThe HTTP status code.
-
errstring RequiredA human-readable description of the failure.
The account’s billing is past due and writes are locked. Reads keep working; editing resumes once billing is settled.
application/json
Error
An error response.
-
codeinteger RequiredThe HTTP status code.
-
errstring RequiredA human-readable description of the failure.
The key lacks write permission, or the account’s plan does not include API access.
application/json
Error
An error response.
-
codeinteger RequiredThe HTTP status code.
-
errstring RequiredA human-readable description of the failure.
No such resource in this account, or article_id does not match the pattern this route accepts.
text/plain
The failure, as a human-readable message.
-
string
The failure, as a human-readable message.
Rate limited. Wait the number of seconds in Retry-After before trying again. X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset say which allowance was spent and when it refills.
-
Retry-Afterinteger -
X-RateLimit-Limitinteger -
X-RateLimit-Remaininginteger -
X-RateLimit-Resetinteger
application/json
Error
An error response.
-
codeinteger RequiredThe HTTP status code.
-
errstring RequiredA human-readable description of the failure.