Difference between revisions of "API Delete Comment"
IVSWikiBlue (talk | contribs) (Created page with "This API call deletes a specific comment by its ID. ===Resource URL=== <pre>http://valt.example.com/api/v3/comment/{id}</pre> ''Replace {id} with the actual ID number of the...") |
IVSWikiBlue (talk | contribs) |
||
| Line 67: | Line 67: | ||
==Examples== | ==Examples== | ||
===Request=== | ===Request=== | ||
| − | <pre>https://ivstest1.ad.ipivs.com/api/v3/comment/42?access_token= | + | <pre>https://ivstest1.ad.ipivs.com/api/v3/comment/42?access_token=exampletoken</pre> |
===Successful Response=== | ===Successful Response=== | ||
Latest revision as of 15:38, 18 September 2026
This API call deletes a specific comment by its ID.
Contents
Resource URL
http://valt.example.com/api/v3/comment/{id}
Replace {id} with the actual ID number of the comment.
Resource Information
| Method | DELETE |
| Headers | Content-Type: application/json |
| Response Type | JSON |
| Authentication Required | Yes |
Parameters
Path Parameters
| Parameter | Description | Example |
|---|---|---|
| id | The ID of the comment to delete. | 42 |
Response
| Code | Reason |
|---|---|
| 200 | Comment Deleted Successfully |
| 400 | Invalid Request (See Response for Specific Error) |
| 401 | Unauthorized |
| 404 | Comment Not Found |
| 500 | Internal Server Error |
| Field | Type | Description |
|---|---|---|
| id | int | The ID of the deleted comment. |
Examples
Request
https://ivstest1.ad.ipivs.com/api/v3/comment/42?access_token=exampletoken
Successful Response
Sample response is shown with line breaks to make it more readable. Actual responses will not include line breaks.
{
"id": 42
}
Failure Response
Sample response is shown with line breaks to make it more readable. Actual responses will not include line breaks.
{
"error": {
"code": 500,
"message": "Internal Server Error"
}
}
Not Found Response
Returned when no comment exists with the specified ID.
{
"title": "An error occurred",
"status": 404,
"detail": "Not Found"
}