Update multiple Knowledge Base entries at once

post

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

Allows for changing the status (e.g., active, archived) of multiple Knowledge Base entries within a project simultaneously. Requires a list of Knowledge Base entry IDs and the target status.

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 to which save/retrieved data is connected

Body Params

Contains a list of Knowledge Base entry ids and the target status to apply to all of them.

Request body for bulk updating the status of multiple Knowledge Base entries.

array of integers

required

length between 1 and 100

A list of Knowledge Base entry unique numerical identifiers to be affected by a bulk operation.

id*

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

200Indicates the outcome of a bulk operation (e.g., bulk update or delete). Provides a general success message and an errors array listing any entities that could not be processed, along with the reason for failure for each.

defaultIndicates an error occurred while processing the request. The code provides an HTTP status code, message offers a human-readable explanation or an array of validation errors, and fields (if present) specifies which input fields were problematic.