PUT/api/v1/kb-articles/{id}

Product availabilityAlgaPSAAlgaDesk

Update a knowledge base article

Updates article metadata (title, slug, type, audience, category, status, review cycle). Validates slug uniqueness, syncs the linked document name when the title changes, and recomputes the next review date when the review cycle changes.

RBAC · document

Path parameters

idstring <uuid>Required

KB article UUID.

Request body

Content type: application/json · schema KbArticleUpdateRequest

titlestring

min length 1 · max length 255

slugstring

article_typestring

Enum: how_tofaqtroubleshootingreference

audiencestring

Enum: internalclientpublic

category_idstring <uuid>

review_cycle_daysinteger

statusstring

Enum: draftreviewpublishedarchived

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

Updated article.

400

Invalid request.

401

API key missing/invalid.

403

Caller lacks the required document permission.

404

Article not found.

500

Unexpected error.

PUT /api/v1/kb-articles/{id}

cURL

curl -X PUT "https://algapsa.com/api/v1/kb-articles/{id}" \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "x",
  "slug": "string",
  "article_type": "how_to",
  "audience": "internal",
  "category_id": "01HN2K7VRB9PQ3Y0000000000",
  "review_cycle_days": 1,
  "status": "draft"
}'

TypeScript

const response = await fetch("https://algapsa.com/api/v1/kb-articles/{id}", {
  method: "PUT",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "title": "x",
    "slug": "string",
    "article_type": "how_to",
    "audience": "internal",
    "category_id": "01HN2K7VRB9PQ3Y0000000000",
    "review_cycle_days": 1,
    "status": "draft"
  })
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Put, "https://algapsa.com/api/v1/kb-articles/{id}");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
request.Headers.TryAddWithoutValidation("Content-Type", "application/json");
request.Content = new StringContent(@"{
  ""title"": ""x"",
  ""slug"": ""string"",
  ""article_type"": ""how_to"",
  ""audience"": ""internal"",
  ""category_id"": ""01HN2K7VRB9PQ3Y0000000000"",
  ""review_cycle_days"": 1,
  ""status"": ""draft""
}", Encoding.UTF8, "application/json");
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": {}
}