Set project favorite
set_project_favoriteToggle a project's favorite status for an OpenProject user, adding or removing it from their personal favorites list.
Instructions
Add or remove a project from the authenticated user's favorites (OpenProject 17+).
Favorites are per user, not per project: this changes what the account behind OPENPROJECT_API_KEY sees starred on its own overview page, and nothing about the project itself or about anybody else's view. Use it when the user asks to pin, star or favorite a project they work in.
Returns {id, favorite, message} — favorite is the state now in effect. The call
is idempotent: favoriting an already-favorited project succeeds again.
Pitfalls: this endpoint only exists from OpenProject 17. When the instance reports a version older than that the call is REFUSED before anything is sent, with the detected version in the message, because there is no downgrade that would achieve the same thing — favorite the project in the web UI instead. When it reports no version at all the request IS sent, since an unreported version says nothing about the endpoint. A 404 is ambiguous on purpose in the hint: it means either the project does not exist for this account or the endpoint is missing. This is not project 'status' and not a work-package watcher.
Cross-references: list_projects(favorites_only=true) lists the current favorites
(and works on older instances too); get_project resolves an identifier first;
get_instance_info reports the detected OpenProject version.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| favorite | Yes | true adds the project to the authenticated user's favorites, false removes it. Required — there is no toggle, so read the current state with list_projects(favorites_only=true) if you do not know it. | |
| id_or_identifier | Yes | Numeric project id or URL identifier to favorite or un-favorite; both are accepted and come from list_projects or get_project. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Project id or identifier that was changed. | |
| message | Yes | Human-readable confirmation. | |
| favorite | Yes | The state now in effect: true when the project was favorited, false when the favorite was removed. |