--- updatedAt: 2026-05-20T20:59:45.000Z agentTools: projectIndex: https://docs.developers.convert.com/llms.txt --- # Update multiple Knowledge Base entries at once 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. # OpenAPI definition ```json { "openapi": "3.0.3", "info": { "title": "Convert Management API", "description": "Move your app forward with the Convert API. The Convert API allows\nyou to manage your Convert Experiences projects using code. The REST API is\nan interface for managing and extending functionality of Convert. For\nexample, instead of creating and maintaining projects using the Convert\nExperiences web dashboard you can create an experiment programmatically.\nAdditionally, if you prefer to run custom analysis on experiment results you\ncan leverage the API to pull data from Convert Experiences into your own\nworkflow. If you do not have a Convert account already, sign up for a free\ndeveloper account at https://www.convert.com/api/.\n\n*[Convert API V1](/doc/v1) is still available and documentation can be found [here](/doc/v1) but using it is highly discouraged\nas it will be phased out in the future*\n", "version": "2.0.0" }, "x-tagGroups": [ { "name": "Client Authentication", "tags": [ "API KEY Authentication", "Cookie Authentication", "OAuth Authorization" ] }, { "name": "Common Parameters", "tags": [ "Optional Fields", "Expandable Fields" ] }, { "name": "Requests", "tags": [ "User", "Accounts", "AI content", "Collaborators", "API Keys", "Notifications", "Projects", "SDK Keys", "Experiences", "Experience Variations", "Experience Sections", "Section Versions", "Version Changes", "Experiences Reports", "Experiences Heatmaps", "Goals", "Hypotheses", "Knowledge Bases", "Observations", "Locations", "Audiences", "Domains", "Cdn Images", "Files", "Tags", "Features", "Visitor Insights", "Visitors Data", "Visitor Data Placeholders", "OAuth", "Approval Requests" ] } ], "paths": { "/accounts/{account_id}/projects/{project_id}/knowledge-bases/bulk-update": { "post": { "operationId": "bulkKnowledgeBasesUpdate", "x-mutates": true, "summary": "Update multiple Knowledge Base entries at once", "description": "Allows for changing the status (e.g., active, archived) of multiple Knowledge Base entries within a project simultaneously.\nRequires a list of Knowledge Base entry IDs and the target status.\n", "tags": [ "Knowledge Bases", "Bulk" ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "description": "ID of the account that owns the retrieved/saved data", "schema": { "type": "integer" } }, { "name": "project_id", "description": "ID of the project to which save/retrieved data is connected", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "$ref": "#/components/requestBodies/BulkUpdateKnowledgeBasesRequest" }, "responses": { "200": { "$ref": "#/components/responses/BulkSuccessResponse" }, "default": { "$ref": "#/components/responses/ErrorResponse" } } } } }, "servers": [ { "url": "https://api.convert.com/api/v2", "description": "Live API server" }, { "url": "https://apidev.convert.com/api/v2", "description": "DEV API server" }, { "url": "http://apidev.convert.com:5000/api/v2", "description": "DEV mocked API server" } ], "components": { "securitySchemes": { "secretKey": { "type": "http", "scheme": "bearer", "description": "See **[API Key Authentication](/reference/api-key-authentication)** for more information.\n" }, "cookieAuthentication": { "type": "apiKey", "in": "cookie", "name": "sid", "description": "Cookie authentication is used against Convert's own IdentityProvider or third party identity providers and is described more in the \"[Cookie Authentication](/reference/cookie-authentication)\" section" }, "requestSigningAppId": { "type": "apiKey", "in": "header", "name": "Convert-Application-ID", "description": "HMAC request signing — the Application ID from your Convert account. See **[API Key Authentication](/reference/api-key-authentication)** for how to generate the full three-header set." }, "requestSigningExpires": { "type": "apiKey", "in": "header", "name": "Expires", "description": "HMAC request signing — UNIX timestamp after which the signature expires. See **[API Key Authentication](/reference/api-key-authentication)** for how to compute it." }, "requestSigningAuthorization": { "type": "apiKey", "in": "header", "name": "Authorization", "description": "HMAC request signing — format: `Convert-HMAC-SHA256 Signature=`. See **[API Key Authentication](/reference/api-key-authentication)** for the signing algorithm. The \"Try It\" playground cannot compute this for you; paste a pre-computed signature here or use the Bearer method instead." } }, "requestBodies": { "BulkUpdateKnowledgeBasesRequest": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkUpdateKnowledgeBasesRequestData" } } }, "description": "Contains a list of Knowledge Base entry `id`s and the target `status` to apply to all of them.", "required": true } }, "responses": { "ErrorResponse": { "description": "Indicates 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.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorData" } } } }, "BulkSuccessResponse": { "description": "Indicates 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.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkSuccessData" } } } } }, "schemas": { "ErrorData": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "message": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "context": { "type": "object", "description": "Additional context about the error." } } }, "SuccessData": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "message": { "type": "string" } } }, "BulkSuccessData": { "allOf": [ { "$ref": "#/components/schemas/SuccessData" }, { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "errors": { "type": "array", "description": "List of unprocessed entities. Would be empty, if all passed entities processed", "items": { "$ref": "#/components/schemas/BulkEntityError" } } } } ] }, "BulkEntityError": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "integer", "description": "The unique identifier of the entity that could not be processed." }, "message": { "type": "string", "description": "A message explaining the reason for the failure for this specific entity." } } }, "KnowledgeBaseStatuses": { "description": "The status of a Knowledge Base entry:\n- `active`: The entry is current and relevant.\n- `archived`: The entry is kept for historical purposes but may no longer be considered current best practice or has been superseded by newer learnings.\n", "type": "string", "enum": [ "active", "archived" ], "default": "active" }, "BulkKnowledgeBaseIds": { "type": "array", "description": "A list of Knowledge Base entry unique numerical identifiers to be affected by a bulk operation.", "items": { "type": "integer" }, "minItems": 1, "maxItems": 100 }, "BulkUpdateKnowledgeBasesRequestData": { "type": "object", "description": "Request body for bulk updating the status of multiple Knowledge Base entries.", "additionalProperties": false, "properties": { "id": { "$ref": "#/components/schemas/BulkKnowledgeBaseIds" }, "status": { "$ref": "#/components/schemas/KnowledgeBaseStatuses" } }, "required": [ "id", "status" ] } } }, "security": [ { "requestSigningAppId": [], "requestSigningExpires": [], "requestSigningAuthorization": [] }, { "secretKey": [] }, { "cookieAuthentication": [] } ] } ```