POST/api/v1/kb-articles/{id}/publish

Product availabilityAlgaPSAAlgaDesk

Publish a knowledge base article

Sets the article status to published, records the publish timestamp and user, and sets is_client_visible on the linked document when the audience is client or public. Returns the updated article.

RBAC · document

Path parameters

idstring <uuid>Required

KB article UUID.

Response body

Success response 200 · schema KbArticleResponse

dataobjectRequired

A knowledge base article and its metadata.

article_idstring <uuid>Required

tenantstring <uuid>Required

document_idstring <uuid>Required

Underlying document backing the article.

titlestringRequired

slugstringRequired

article_typestringRequired

Enum: how_tofaqtroubleshootingreference

audiencestringRequired

Enum: internalclientpublic

statusstringRequired

Enum: draftreviewpublishedarchived

category_idstring <uuid>Nullable

review_cycle_daysintegerNullable

next_review_datestringNullable

published_atstringNullable

published_bystring <uuid>Nullable

document_namestringNullable

Joined from the documents table.

created_atstring

updated_atstring

metaobject

Response codes

200

Article published.

400

Invalid request.

401

API key missing/invalid.

403

Caller lacks the required document permission.

404

Article not found.

500

Unexpected error.

POST /api/v1/kb-articles/{id}/publish

cURL

curl -X POST "https://algapsa.com/api/v1/kb-articles/{id}/publish" \
  -H "X-API-Key: $ALGA_API_KEY"

TypeScript

const response = await fetch("https://algapsa.com/api/v1/kb-articles/{id}/publish", {
  method: "POST",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
  }
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://algapsa.com/api/v1/kb-articles/{id}/publish");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "data": {
    "article_id": "01HN2K7VRB9PQ3Y0000000000",
    "tenant": "01HN2K7VRB9PQ3Y0000000000",
    "document_id": "01HN2K7VRB9PQ3Y0000000000",
    "title": "string",
    "slug": "string",
    "article_type": "how_to",
    "audience": "internal",
    "status": "draft",
    "category_id": "01HN2K7VRB9PQ3Y0000000000",
    "review_cycle_days": 1,
    "next_review_date": "string",
    "published_at": "string",
    "published_by": "01HN2K7VRB9PQ3Y0000000000",
    "document_name": "string",
    "created_at": "string",
    "updated_at": "string"
  },
  "meta": {}
}