Create news
create_newsPublish news announcements in OpenProject to share release notes, weekly reports, or maintenance updates with the entire project team.
Instructions
Publish a news announcement in a project.
Use it for release notes, a weekly report, a maintenance window — anything the whole project should see on its overview page. The author is the authenticated account and is set by the server; project members watching the project are notified.
Returns the created entry {id, title, summary, description, project, author, created_at, updated_at, can_manage}; the id is what update_news and
delete_news consume.
Pitfalls: this needs the 'manage news' permission in that project, which exists only
while the project has the news module enabled — a 403 is about the account or the
module, never about the text. title is required and rejected when blank (checked
here, before the request). There is no draft state: the entry is public to everyone
who can view the project the moment it is created. News is not a work package — for
something that needs assigning and tracking use create_work_package instead.
Cross-references: list_news to see what is already published (and to avoid
duplicates); update_news to correct an entry afterwards; list_projects for
the project id.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| title | Yes | Headline, required, up to 256 characters. This is what readers see in the project overview and in notification digests. | |
| summary | No | Optional teaser shown under the headline, up to 255 characters. Plain text, not markdown. Omit for none. | |
| project_id | Yes | Numeric id (or URL identifier, resolved for you) of the project to publish in. The project cannot be changed afterwards, and it must have the news module enabled. | |
| description | No | The announcement body as markdown — headings, lists and links all render. Omit for a headline-only entry. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | News id — what get_news, update_news and delete_news consume. | |
| title | No | Headline of the announcement. | |
| author | No | User who published it ({id, name}); set by the server. | |
| project | No | Project the announcement belongs to ({id, name}). | |
| summary | No | Short teaser OpenProject shows under the headline; may be empty. The full body is NOT here — read it with get_news(news_id=...). | |
| can_manage | No | True when this account may change or delete this entry (OpenProject renders the update/delete links only with the 'manage news' permission). False means update_news and delete_news would fail with 403. | |
| created_at | No | ISO 8601 UTC publication timestamp. | |
| updated_at | No | ISO 8601 UTC timestamp. | |
| description | No | The announcement body as markdown (raw); html is dropped. Empty string when the entry has only a headline and summary. |