v1

latestOpenAPI 3.0.02026-07-26866217.8 KB
Knowledge Base

Update Knowledge Base

Replace an existing knowledge base entry. This endpoint performs a full replacementscope_property, scope_channel, contents and is_enable must all be supplied. Use GET /knowledge_bases/{id} first if you only want to change one field.

patch/knowledge_bases/{id}

Path parameters

idinteger required

The ID of the knowledge base entry to update.

Request body

titlestring

Optional title for the knowledge base entry.

is_enableboolean required

Whether the entry is enabled.

Response

The knowledge base entry has been updated successfully.

request_idstring required

Unique identifier for the request.

error_codeinteger required

Numeric error code representing the status of the response. A value of 200 indicates success. <br> See the Error Codes section for more information.

error_msgstring required

Message detailing the status of the response.

Example response

{
  "error_msg": "Done."
}