Update the status of a Knowledge Base entry

post

https://api.convert.com/api/v2/accounts/{account_id}/projects/{project_id}/knowledge-bases/{knowledge_base_id}/update-status

Changes the status of an existing Knowledge Base entry (e.g., from 'active' to 'archived').

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account_id

integer

required

ID of the account that owns the retrieved/saved data

project_id

integer

required

ID of the project into which the knowledge base is to be updated

knowledge_base_id

integer

required

ID of the knowledge base to be updated

Query Params

expand

array of objects

Specifies the list of fields which would be expanded in the response. Otherwise, only their id would be returned.

Read more in the section related to Expanding Fields

expand

Body Params

Request body for updating the status of a Knowledge Base entry.

status

string

enum

required

Defaults to active

The status of a Knowledge Base entry:

active: The entry is current and relevant.
archived: The entry is kept for historical purposes but may no longer be considered current best practice or has been superseded by newer learnings.

Allowed:

Responses

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Detailed information for a single Knowledge Base entry, including its name, summary of findings, status (active/archived), creator, and associated tags.