The API token used for authenticating the request. This must be passed as a header parameter. To generate an API token, go to Settings > Knowledge base portal > API tokens. This token must correspond to a valid workspace and permission level.
The ID of the article. Fetch via GET /v2/projectversions/{projectVersionId}/articles.
Language code of the article translation (for example en, fr, de-DE, pt-BR). Use GET /v2/language/{projectVersionId} to list the codes enabled for a workspace. Defaults to en when omitted.
Partial settings update — only the fields present in the request body are updated.
This request is used to update the article settings. Kindly make sure the changes for updating your parameters has done successfully.
{
"slug": "updatearticlesettings",
"seo_title": "update",
"description": "This is the description for updating article settings.",
"allow_comments": true,
"show_table_of_contents": true,
"tags": [],
"status_indicator": 2,
"status_indicator_expiry_date": "2024-06-13T14:30:00Z",
"exclude_from_search": true,
"exclude_from_ai_search": false,
"related_articles": [],
"content_type": 0,
"is_acknowledgement_enabled": false,
"exclude_from_external_search": false,
"custom_fields": [
{
"field_id": "field-definition-id-1",
"value": "Canada"
},
{
"field_id": "field-definition-id-2",
"value": 8
},
{
"field_id": "field-definition-id-3",
"value": "option-id-active"
}
]
}The SEO title of the article
The SEO description of the article
Enable or disable the commenting on the article. true - Commenting will be enabled; false - Commenting will be disabled
Enable or disable the Table of Contents (TOC) for the article in the knowledge base. true - TOC will be enabled; false - TOC will be disabled
Custom article tags
Article status in the knowledge base. 0 - None; 1 - New; 2 - Updated; 3 - Custom
The date-time when the public article status is removed
true - The article will not appear in search results in the knowledge base; false - The article will appear in search results in the knowledge base
true - The Eddy-AI assistant will not fetch information from this article; false - The Eddy-AI assistant will not exclude this article while fetching information
The list of related article IDs to show in the knowledge base
0 - Markdown; 1 - WYSIWYG(HTML); 2 - Advanced WYSIWYG
Set this to true to prevent the page from being indexed by external search engines. Document360 will automatically add a robots meta tag and exclude the page from the sitemap it generates.
Custom field values to update. Only provided fields will be updated (partial update supported).
Request model for updating a custom field value
The ID of the custom field definition
The value to set for the custom field. Type depends on field type:
- Text/TextArea: string
- Number: int or double
- Boolean: bool
- Date: DateTime (ISO 8601 format)
- Dropdown: string (option ID)
- MultiSelectDropdown: List
(array of option IDs)
This request is used to update the article settings. Kindly make sure the changes for updating your parameters has done successfully.
{
"slug": "updatearticlesettings",
"seo_title": "update",
"description": "This is the description for updating article settings.",
"allow_comments": true,
"show_table_of_contents": true,
"tags": [],
"status_indicator": 2,
"status_indicator_expiry_date": "2024-06-13T14:30:00Z",
"exclude_from_search": true,
"exclude_from_ai_search": false,
"related_articles": [],
"content_type": 0,
"is_acknowledgement_enabled": false,
"exclude_from_external_search": false,
"custom_fields": [
{
"field_id": "field-definition-id-1",
"value": "Canada"
},
{
"field_id": "field-definition-id-2",
"value": 8
},
{
"field_id": "field-definition-id-3",
"value": "option-id-active"
}
]
}The SEO title of the article
The SEO description of the article
Enable or disable the commenting on the article. true - Commenting will be enabled; false - Commenting will be disabled
Enable or disable the Table of Contents (TOC) for the article in the knowledge base. true - TOC will be enabled; false - TOC will be disabled
Custom article tags
Article status in the knowledge base. 0 - None; 1 - New; 2 - Updated; 3 - Custom
The date-time when the public article status is removed
true - The article will not appear in search results in the knowledge base; false - The article will appear in search results in the knowledge base
true - The Eddy-AI assistant will not fetch information from this article; false - The Eddy-AI assistant will not exclude this article while fetching information
The list of related article IDs to show in the knowledge base
0 - Markdown; 1 - WYSIWYG(HTML); 2 - Advanced WYSIWYG
Set this to true to prevent the page from being indexed by external search engines. Document360 will automatically add a robots meta tag and exclude the page from the sitemap it generates.
Custom field values to update. Only provided fields will be updated (partial update supported).
Request model for updating a custom field value
The ID of the custom field definition
The value to set for the custom field. Type depends on field type:
- Text/TextArea: string
- Number: int or double
- Boolean: bool
- Date: DateTime (ISO 8601 format)
- Dropdown: string (option ID)
- MultiSelectDropdown: List
(array of option IDs)
This request is used to update the article settings. Kindly make sure the changes for updating your parameters has done successfully.
{
"slug": "updatearticlesettings",
"seo_title": "update",
"description": "This is the description for updating article settings.",
"allow_comments": true,
"show_table_of_contents": true,
"tags": [],
"status_indicator": 2,
"status_indicator_expiry_date": "2024-06-13T14:30:00Z",
"exclude_from_search": true,
"exclude_from_ai_search": false,
"related_articles": [],
"content_type": 0,
"is_acknowledgement_enabled": false,
"exclude_from_external_search": false,
"custom_fields": [
{
"field_id": "field-definition-id-1",
"value": "Canada"
},
{
"field_id": "field-definition-id-2",
"value": 8
},
{
"field_id": "field-definition-id-3",
"value": "option-id-active"
}
]
}The SEO title of the article
The SEO description of the article
Enable or disable the commenting on the article. true - Commenting will be enabled; false - Commenting will be disabled
Enable or disable the Table of Contents (TOC) for the article in the knowledge base. true - TOC will be enabled; false - TOC will be disabled
Custom article tags
Article status in the knowledge base. 0 - None; 1 - New; 2 - Updated; 3 - Custom
The date-time when the public article status is removed
true - The article will not appear in search results in the knowledge base; false - The article will appear in search results in the knowledge base
true - The Eddy-AI assistant will not fetch information from this article; false - The Eddy-AI assistant will not exclude this article while fetching information
The list of related article IDs to show in the knowledge base
0 - Markdown; 1 - WYSIWYG(HTML); 2 - Advanced WYSIWYG
Set this to true to prevent the page from being indexed by external search engines. Document360 will automatically add a robots meta tag and exclude the page from the sitemap it generates.
Custom field values to update. Only provided fields will be updated (partial update supported).
Request model for updating a custom field value
The ID of the custom field definition
The value to set for the custom field. Type depends on field type:
- Text/TextArea: string
- Number: int or double
- Boolean: bool
- Date: DateTime (ISO 8601 format)
- Dropdown: string (option ID)
- MultiSelectDropdown: List
(array of option IDs)
This request is used to update the article settings. Kindly make sure the changes for updating your parameters has done successfully.
{
"slug": "updatearticlesettings",
"seo_title": "update",
"description": "This is the description for updating article settings.",
"allow_comments": true,
"show_table_of_contents": true,
"tags": [],
"status_indicator": 2,
"status_indicator_expiry_date": "2024-06-13T14:30:00Z",
"exclude_from_search": true,
"exclude_from_ai_search": false,
"related_articles": [],
"content_type": 0,
"is_acknowledgement_enabled": false,
"exclude_from_external_search": false,
"custom_fields": [
{
"field_id": "field-definition-id-1",
"value": "Canada"
},
{
"field_id": "field-definition-id-2",
"value": 8
},
{
"field_id": "field-definition-id-3",
"value": "option-id-active"
}
]
}The SEO title of the article
The SEO description of the article
Enable or disable the commenting on the article. true - Commenting will be enabled; false - Commenting will be disabled
Enable or disable the Table of Contents (TOC) for the article in the knowledge base. true - TOC will be enabled; false - TOC will be disabled
Custom article tags
Article status in the knowledge base. 0 - None; 1 - New; 2 - Updated; 3 - Custom
The date-time when the public article status is removed
true - The article will not appear in search results in the knowledge base; false - The article will appear in search results in the knowledge base
true - The Eddy-AI assistant will not fetch information from this article; false - The Eddy-AI assistant will not exclude this article while fetching information
The list of related article IDs to show in the knowledge base
0 - Markdown; 1 - WYSIWYG(HTML); 2 - Advanced WYSIWYG
Set this to true to prevent the page from being indexed by external search engines. Document360 will automatically add a robots meta tag and exclude the page from the sitemap it generates.
Custom field values to update. Only provided fields will be updated (partial update supported).
Request model for updating a custom field value
The ID of the custom field definition
The value to set for the custom field. Type depends on field type:
- Text/TextArea: string
- Number: int or double
- Boolean: bool
- Date: DateTime (ISO 8601 format)
- Dropdown: string (option ID)
- MultiSelectDropdown: List
(array of option IDs)
Operation succeeded. Inspect the response envelope's success flag and the result/data payload.
This response indicate a article settings has been successfully updated.
{
"data": {
"url": "https://example.com/v1/docs/en/getting-started",
"slug": "updatearticlesettings",
"seo_title": "update",
"description": "This is the description for updating article settings.",
"allow_comments": true,
"show_table_of_contents": true,
"featured_image_url": "",
"tags": [],
"status_indicator": 2,
"status_indicator_expiry_date": "2024-06-13T14:30:00Z",
"exclude_from_search": true,
"exclude_from_ai_search": false,
"exclude_from_external_search": false,
"related_articles": [],
"is_acknowledgement_enabled": false,
"custom_fields": [
{
"field_id": "field-definition-id-1",
"name": "Country",
"type": 0,
"value": "Canada"
},
{
"field_id": "field-definition-id-2",
"name": "Priority",
"type": 6,
"value": 8
},
{
"field_id": "field-definition-id-3",
"name": "Status",
"type": 2,
"value": "option-id-active",
"options": [
{
"id": "option-id-active",
"label": "Active"
},
{
"id": "option-id-inactive",
"label": "Inactive"
}
]
}
]
},
"extension_data": null,
"success": true,
"errors": [],
"warnings": [],
"information": [
{
"extension_data": null,
"description": "Article settings updated successfully"
}
]
}update article settings
Url of the article
The slug of the article
The SEO title of the article
The SEO description of the article
True indicates that comments are allowed in the article
True indicates that Table of Contents are shown in the article
URL of the featured image
List of tags associated to the article
The status of the article: 0 - None, 1 - New, 2 - Updated, 3 - Custom
The number of days after which the article status will be removed
True indicates that the article will not appear in the Knowledge base search results
List of related articles associated to the article
The ID of the article
The title of the article
True indicates that the article is hidden
The slug of the article
Custom field values associated with the article
Represents a custom field value with its definition metadata
Unique identifier of the custom field definition
The display name of the custom field
The type of the custom field. 0 = Text, 1 = TextArea, 2 = Dropdown, 3 = MultiSelectDropdown, 4 = Date, 5 = Boolean, 6 = Number
The value of the custom field. Type depends on field type:
- Text/TextArea: string
- Number: int or double
- Boolean: bool
- Date: DateTime
- Dropdown: string (selected option ID)
- MultiSelectDropdown: List
(array of selected option IDs)
Available options for Dropdown and MultiSelectDropdown fields. Omitted for other field types.
Option definition for dropdown fields
The option ID (use this value when updating)
The display label for the option
Extension data for customer API response
Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.
A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.
One structured error in a response's Document360.Core.Messages.Core.BaseResponse.errors array.
This is the Extension data object
A technical trace showing where the error occurred within the system. Intended for backend debugging.
A clear message explaining what caused the error. This helps quickly understand what went wrong.
A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.
Any structured metadata for the error object.
A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.
One non-fatal warning attached to an otherwise-successful response.
Extension Data for customer Api warning
A plain message that describes the warning and helps understand what should be reviewed.
A short, predefined code that uniquely identifies the warning type.
Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.
One informational message in a response's Document360.Core.Messages.Core.BaseResponse.information array. Non-error context the SPA may surface to the user.
Extension data for customer Api response information
A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.
The request body or query parameters failed validation. Inspect errors[].description for the offending fields.
This response is due to an empty request body. \n Kindly make some body parameters to get success response.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "A non-empty request body is required.",
"error_code": "400",
"custom_data": null
}
],
"warnings": [],
"information": []
}Extension data for customer API response
Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.
A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.
One structured error in a response's Document360.Core.Messages.Core.BaseResponse.errors array.
This is the Extension data object
A technical trace showing where the error occurred within the system. Intended for backend debugging.
A clear message explaining what caused the error. This helps quickly understand what went wrong.
A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.
Any structured metadata for the error object.
A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.
One non-fatal warning attached to an otherwise-successful response.
Extension Data for customer Api warning
A plain message that describes the warning and helps understand what should be reviewed.
A short, predefined code that uniquely identifies the warning type.
Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.
One informational message in a response's Document360.Core.Messages.Core.BaseResponse.information array. Non-error context the SPA may surface to the user.
Extension data for customer Api response information
A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.
Authentication failed — the api_token header is missing, malformed, or has been revoked.
Extension data for customer API response
Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.
A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.
One structured error in a response's Document360.Core.Messages.Core.BaseResponse.errors array.
This is the Extension data object
A technical trace showing where the error occurred within the system. Intended for backend debugging.
A clear message explaining what caused the error. This helps quickly understand what went wrong.
A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.
Any structured metadata for the error object.
A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.
One non-fatal warning attached to an otherwise-successful response.
Extension Data for customer Api warning
A plain message that describes the warning and helps understand what should be reviewed.
A short, predefined code that uniquely identifies the warning type.
Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.
One informational message in a response's Document360.Core.Messages.Core.BaseResponse.information array. Non-error context the SPA may surface to the user.
Extension data for customer Api response information
A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.
The requested resource was not found, or the supplied identifier does not exist in the project.
Extension data for customer API response
Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.
A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.
One structured error in a response's Document360.Core.Messages.Core.BaseResponse.errors array.
This is the Extension data object
A technical trace showing where the error occurred within the system. Intended for backend debugging.
A clear message explaining what caused the error. This helps quickly understand what went wrong.
A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.
Any structured metadata for the error object.
A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.
One non-fatal warning attached to an otherwise-successful response.
Extension Data for customer Api warning
A plain message that describes the warning and helps understand what should be reviewed.
A short, predefined code that uniquely identifies the warning type.
Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.
One informational message in a response's Document360.Core.Messages.Core.BaseResponse.information array. Non-error context the SPA may surface to the user.
Extension data for customer Api response information
A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.
Rate limit exceeded for this api_token. Wait for the duration in the Retry-After header before retrying.
Extension data for customer API response
Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.
A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.
One structured error in a response's Document360.Core.Messages.Core.BaseResponse.errors array.
This is the Extension data object
A technical trace showing where the error occurred within the system. Intended for backend debugging.
A clear message explaining what caused the error. This helps quickly understand what went wrong.
A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.
Any structured metadata for the error object.
A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.
One non-fatal warning attached to an otherwise-successful response.
Extension Data for customer Api warning
A plain message that describes the warning and helps understand what should be reviewed.
A short, predefined code that uniquely identifies the warning type.
Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.
One informational message in a response's Document360.Core.Messages.Core.BaseResponse.information array. Non-error context the SPA may surface to the user.
Extension data for customer Api response information
A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.
Note: When updating article settings via the API, any previously configured status_indicator_expiry_date is considered only if it is explicitly included in the request payload. If the expiry date is omitted or set to null, the existing expiry date is cleared and will no longer participate in subsequent validation checks. This allows other article settings, such as the article slug, to be updated independently without triggering status indicator expiry date validation errors.