Delete news
delete_newsPermanently delete a news entry to correct a mistaken publication or wrong project placement. Deletion is irreversible, so confirm before executing.
Instructions
Permanently delete a news entry.
Use it for an announcement published by mistake or in the wrong project. For an
outdated but real announcement, update_news is usually the better answer: the
entry stays part of the project's record.
Returns a small confirmation once OpenProject accepts the deletion.
Pitfalls: the entry and every comment left on it are removed for good — API v3 offers no undo and no trash. The 'manage news' permission is required, so a 403 is about the account or a disabled news module; a 404 means the id is wrong or its news is not visible to you.
Cross-references: list_news/get_news for the id and for can_manage;
update_news for the reversible alternative.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| confirm | No | Must be true. Ask the user first: there is no undo. Calling with confirm=false returns a confirmation_required error and deletes nothing. | |
| news_id | Yes | Numeric news id to delete. Read it back with get_news first — headlines repeat across projects, ids do not. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Id of the news entry that was deleted. | |
| deleted | Yes | True once OpenProject accepted the deletion. | |
| message | Yes | Human-readable confirmation. |