Delete a help article

Soft-delete a help article. Its helpfulness votes and view history are preserved.

Soft-deletes a help article. It disappears from your dashboard and public help center, but the row is retained and its slug is freed for reuse.

The article's "was this helpful?" votes and view records are not removed, so restoring it in the database preserves its history.

Unlike collections and categories, deleting an article cascades to nothing — an article is a leaf. Curated links pointing at it from other articles simply stop being surfaced.

Endpoint

POST https://api.productbridge.io/api/external/v1/help-articles/delete

Arguments

body

api_keystring

Required

Your organization's public API key. See Authentication.

body

article_idstring

Required

UUID of the article to delete. Must belong to your organization.

Returns

{ "success": true }

Example request

curl -X POST https://api.productbridge.io/api/external/v1/help-articles/delete \
  -H 'Content-Type: application/json' \
  -d '{
    "api_key": "pb_YOUR_PUBLIC_API_KEY",
    "article_id": "aa1c3ef8-b8cd-cd15-01ba-77bb77bb77bb"
  }'

const res = await fetch(
  "https://api.productbridge.io/api/external/v1/help-articles/delete",
  {
    method: "POST",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify({
      api_key: process.env.PRODUCTBRIDGE_API_KEY,
      article_id: "aa1c3ef8-b8cd-cd15-01ba-77bb77bb77bb",
    }),
  }
);
if (!res.ok) throw new Error(`HTTP ${res.status}`);

import os, httpx

resp = httpx.post(
    "https://api.productbridge.io/api/external/v1/help-articles/delete",
    json={
        "api_key": os.environ["PRODUCTBRIDGE_API_KEY"],
        "article_id": "aa1c3ef8-b8cd-cd15-01ba-77bb77bb77bb",
    },
)
resp.raise_for_status()

Example response

{
  "success": true
}

Consider unpublishing instead

If you only want an article off your public help center while keeping it in the dashboard, update it rather than deleting:

{
  "api_key": "pb_YOUR_PUBLIC_API_KEY",
  "article_id": "aa1c3ef8-b8cd-cd15-01ba-77bb77bb77bb",
  "show_on_portal": false
}

Errors

Status	Body	Cause
`401`	`{"detail":{"error":"invalid api_key"}}`	Missing / unknown / inactive `api_key`.
`403`	`{"detail":{"error":"The Help Center is not enabled on your current plan..."}}`	Your plan does not include the `knowledgebase` feature.
`404`	`{"detail":{"error":"help article not found"}}`	No such article, it was already deleted, or it belongs to another organization.
`422`	Validation error envelope	`article_id` missing or not a valid UUID.

See Errors for the full envelope shape and a recommended client-side handler.

Was this page helpful?