Domain name for API request: adp.intl.tencentcloudapi.com.
Batch modify documents.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: ModifyDocList. | ||||||||||||||||||
| Version | Yes | String | Common Params. The value used for this API: 2026-05-20. | ||||||||||||||||||
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. | ||||||||||||||||||
| DocIdList.N | Yes | Array of String | Document ID list to be modified (quantity: 1-20) |
||||||||||||||||||
| KbId | Yes | String | Knowledge base ID |
||||||||||||||||||
| CategoryId | No | String | Ownership category ID |
||||||||||||||||||
| EffectiveDomain | No | Integer | Application scope
|
||||||||||||||||||
| ExpirationPolicy | No | ExpirationPolicy | Expiration policy (validity time and behavior after the validity period expires) |
||||||||||||||||||
| ExternalLink | No | DocExternalLink | External link |
||||||||||||||||||
| LabelRefList | No | LabelRefIdentityList | Tag list. |
||||||||||||||||||
| Switch | No | DocSwitch | Switch configuration |
| Parameter Name | Type | Description |
|---|---|---|
| ResultList | Array of OperationResult | Batch modification result. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
Batch modify documents
POST / HTTP/1.1
Host: adp.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyDocList
<Common request parameters>
{
"DocIdList": [
"2096882953701315136"
],
"EffectiveDomain": 4,
"KbId": "2096881888856621696"
}
{
"Response": {
"ResultList": [
{
"Id": "2096882953701315136",
"Succeeded": false,
"Reason": "type:business, code:450156, msg:ErrDocNotAllowEdit"
}
],
"RequestId": "07edd952-9922-4f3e-8af5-13fc4afd6c25"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.
フィードバック