Skip to navigation

Delete a Knowledge API document by ID

Knowledge API sources only. Send complete JSON content with the source article ID in meta.description.id, id or externalId. Imported metadata article IDs match linked documents in this source; _id is used only if no source ID is supplied. Unknown IDs create documents. Returns a queue receipt; the worker processes and publishes according to source policy. The path ID supplies the document identity; any source IDs in the body must match; legacy _id is ignored when a source ID is supplied. DELETE removes only the matching document and needs no body.

Authentication

AuthorizationBearer

Source-specific webhook token shown when configuring the knowledge source; activated only after deployment.

Path parameters

workspaceIdstringRequired
environmentstringRequired
sourceKeystringRequired
documentIdstringRequired<=200 characters

Original source article ID (for example Zendesk article.id), matching imported meta.description.id. V1 block ID is a fallback for records without source IDs.

Headers

Idempotency-KeystringOptional<=200 characters

Response

Event persisted; may already have been accepted

acceptedbooleanOptional
idstringOptional
duplicatebooleanOptional

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
405
Method Not Allowed Error
409
Conflict Error
413
Content Too Large Error
503
Service Unavailable Error