Description

Invalidates (deletes) a knowledge entry. This API is the platform standard object-invalidate API; the object is specified via dataObjectApiName, with a fixed value of ServiceKnowledgeObj.

Invalidation is not physical deletion: the data goes to the recycle bin and is no longer returned by the CRM in-app views or this list API. No restore API is exposed in this release; operate with caution.

Request Specification

HTTP Method: POST + application/json

Request Path: https://${Cloud Domain}/cgi/crm/v2/data/invalid?thirdTraceId=${Random String}

Request Headers: Refer to Common Parameters

Request Parameters

Parameter	Type	Required	Description
data	Map	Yes	Data
dataObjectApiName	String	Yes	Object apiName, fixed value ServiceKnowledgeObj
object_data_id	String	Yes	Knowledge entry ID

Request Example

{
  "data": {
    "dataObjectApiName": "ServiceKnowledgeObj",
    "object_data_id": "68c1a0f0abcd0001"
  }
}

Response Parameters

Parameter	Type	Description
traceId	string	Unique request ID
errorDescription	string	Error description
errorMessage	string	Error message
errorCode	Int	Error Codes

Response Example

{
  "traceId": "E-O.fktest4234.1000-20260914102000-xxxxxx",
  "errorDescription": "success",
  "errorMessage": "OK",
  "errorCode": 0
}

Notes

• Each call invalidates one entry; loop the call for batch invalidation.
• For a published entry (public_status=1), it is recommended to unpublish first.
• Once invalidated, the entry disappears from the CRM in-app views and is excluded from the list API by default.
• Do not use the message field in the response for logical judgment, as errorMessage may change.