How to Update an Existing Topic Using API
You can update an existing article in your Knowledge Base using the ProProfs API. This lets you programmatically modify article titles, content, and more without manually editing through the dashboard.
Key Features:
- Update Pages: Quickly modify existing articles in your knowledge base.
- Improve Content: Refresh titles, content, keywords, and TOC details as needed.
- Access Control: Ensure only authorized users can update topics using their email.
- Flexible Editing: Update only the fields you want without affecting the rest of the article.
- Smooth Integration: Use the API with your existing systems to streamline content updates.
Request Method
POST
Request Format
JSON
POST Parameters
| Field | Required | Type | Description |
| api_key | Yes | String | Your private API key for the Knowledge Base. |
|
action |
Yes | String | Must be "update" to update an existing article. |
| topic_id | Yes | Numeric | ID of the article you want to update. |
| topic_title | No | String | Updated article title. |
| topic_content | No | String | Updated article body/content. |
| user_email | Yes | String | Email of the authorized user. |
Example Update Request
POST https://www.helpdocsonline.com/proprofsapi/article/v1
Accept: application/json
JSON Payload
{
"action": "update",
"api_key": "API_KEY",
"topic_id": 3721140,
"topic_title": "How to Update a Page",
"topic_content": "<p>This is sample data with more content</p>",
“user_email” : “user@example.com”
}
Response Format
JSON
Response Fields
| Field | Description |
| status | Success or failure message. |
| msg | Description of the response. |
| topic_id | ID of the updated article. |
| url | Live URL of the updated article. |
Example Response
{
"status": "SUCCESS",
"msg": "Article updated successfully",
"topic_id": 2257336,
"url": "http://sample.helpdocsonline.com/ID2257336"
}
That is all about how you can update an existing topic with API in the ProProfs Knowledge Base. If you encounter any issues or have any questions, feel free to contact our support team.