Partially updates one organization-owned knowledge-base article. Category, owner, tags, and the complete supplied locale variants are validated against the same organization; published translations are queued for re-embedding after the update. Access requires an active organization administrator session or an organization API key with the `knowledge-base:write` scope. API-key calls also require the automation API module. Data is isolated to the authenticated organization; identifiers from another organization or site are not disclosed.
/api/kb/articles/{id}Organization API key supplied as Authorization: Bearer convor_sk_....
In: header
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
{
"id": "b9a6e922-23ed-4dde-99e8-76d0cf2a0038",
"orgId": "8ea0b557-d794-41ce-b86e-44f4780da2b5",
"categoryId": "6ecda99e-e055-46bd-b0fb-d33ed475b00b",
"tags": [
"billing",
"refund"
],
"title": "How refunds work",
"slug": "how-refunds-work",
"content": "Refunds are reviewed and returned to the original payment method.",
"status": "published",
"locale": "en",
"fallbackUsed": false,
"translations": [
{
"id": "a5bd4fbf-3bc3-414a-87ca-dd3f96098ea3",
"locale": "en",
"status": "published",
"title": "How refunds work",
"slug": "how-refunds-work",
"content": "Refunds are reviewed and returned to the original payment method.",
"sourceLocale": null,
"machineTranslatedAt": null,
"reviewedAt": null,
"reviewedBy": null,
"createdAt": "2026-08-03T18:00:00.000Z",
"updatedAt": "2026-08-03T18:00:00.000Z"
}
],
"deletedAt": null,
"createdAt": "2026-08-03T18:00:00.000Z",
"updatedAt": "2026-08-03T18:00:00.000Z",
"ownerOperatorId": "3f042a6a-579c-4c21-9fd4-c3a8323d5caf",
"ownerName": "Alex Morgan"
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication is required.",
"correlationId": "req_01K0MANAGEMENT401"
}
}{
"error": {
"code": "INTEGRATION_MODULE_REQUIRED",
"message": "The automation API module is required.",
"details": {
"module": "automation_api",
"feature": "public_api"
},
"correlationId": "req_01K0MANAGEMENT402"
}
}{
"error": {
"code": "FORBIDDEN",
"message": "The caller lacks the required role or API-key scope.",
"correlationId": "req_01K0MANAGEMENT403"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "The requested resource was not found.",
"correlationId": "req_01K0MANAGEMENT404"
}
}{
"error": {
"code": "CONFLICT",
"message": "The requested change conflicts with current resource state.",
"correlationId": "req_01K0MANAGEMENT409"
}
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "The request payload is invalid.",
"details": {
"field": "name"
},
"correlationId": "req_01K0MANAGEMENT422"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "Too many requests.",
"correlationId": "req_01K0MANAGEMENT429"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}curl --request PUT \
'https://api.convor.io/api/kb/articles/b9a6e922-23ed-4dde-99e8-76d0cf2a0038' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer convor_sk_...' \
--header 'Content-Type: application/json' \
--data '{
"tags": [
"billing",
"refund",
"payment"
]
}'const response = await fetch("https://api.convor.io/api/kb/articles/b9a6e922-23ed-4dde-99e8-76d0cf2a0038", {
method: "PUT",
headers: {
"Accept": "application/json",
"Authorization": "Bearer convor_sk_...",
"Content-Type": "application/json"
},
body: JSON.stringify({
"tags": [
"billing",
"refund",
"payment"
]
}),
});
const contentType = response.headers.get("content-type") ?? "";
const data = response.status === 204
? null
: contentType.includes("json")
? await response.json()
: contentType.startsWith("text/")
? await response.text()
: await response.blob();
if (!response.ok) {
const message = typeof data === "object" && data !== null
&& "error" in data && typeof data.error === "object"
&& data.error !== null && "message" in data.error
? String(data.error.message)
: "Convor API request failed (" + response.status + ")";
throw new Error(message);
}
console.log(data);Was this page helpful?
Soft-delete a multilingual article
Soft-deletes one organization-owned article so it is removed from public search, suggestions, and help-center listings while retaining its localized content for internal recovery and audit history. Access requires an active organization administrator session or an organization API key with the `knowledge-base:write` scope. API-key calls also require the automation API module. Data is isolated to the authenticated organization; identifiers from another organization or site are not disclosed.
Update multilingual category content
Partially updates one organization-owned category key, icon, sort order, or complete supplied locale variants. Uniqueness and localization lifecycle constraints are revalidated before the updated category is returned. Access requires an active organization administrator session or an organization API key with the `knowledge-base:write` scope. API-key calls also require the automation API module. Data is isolated to the authenticated organization; identifiers from another organization or site are not disclosed.