Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Taykl12/Classify/llms.txt

Use this file to discover all available pages before exploring further.

The favorite toggle lets project owners pin a project to the dashboard carousel for quick access. Favoriting is a per-user preference stored on the project record — it is visible only to the owner and does not affect how other team members see the project. Send isFavorite: true to add the project to the carousel and isFavorite: false to remove it. Only the registered project owner can change this flag; members and unrelated users receive a 403.

​
Endpoint

PATCH /api/projects/:id/favorite

​
Path Parameters

​
id
string
required
The numeric project identifier.

​
Request

​
Headers

HeaderValue
AuthorizationBearer <token>
Content-Typeapplication/json

​
Body Parameters

​
isFavorite
boolean
required
Pass true to mark the project as a favorite and surface it in the dashboard carousel. Pass false to remove it from the carousel.

​
Example

# Mark as favorite
curl -X PATCH https://your-domain.com/api/projects/42/favorite \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{ "isFavorite": true }'

​
Response

Returns 200 OK with the updated project list item, reflecting the new isFavorite value.

​
Response Fields

​
id
string
required
Project identifier.
​
name
string
required
Project name.
​
description
string
required
Short project description. Empty string ("") when not set.
​
status
"Abierto" | "Cerrado"
required
Current lifecycle state.
​
isFavorite
boolean
required
The updated favorite state — reflects the value sent in the request body.
​
createdAt
string
required
Creation date formatted as DD/MM/YYYY (e.g. "01/09/2024"), derived from fecha_creacion.
​
scopeNotes
string
required
Supplementary scope notes (notas_alcance). Empty string ("") when not set.
​
preprojectValidated
boolean
required
Whether the pre-project document has been validated by the assigned professor.

​
Example Response

{
  "id": "42",
  "name": "AI Grading System",
  "description": "Automated rubric evaluation using NLP",
  "scopeNotes": "",
  "status": "Abierto",
  "isFavorite": true,
  "createdAt": "01/09/2024",
  "preprojectValidated": false
}

​
Error Responses

StatusDescription
400 Bad RequestisFavorite was not provided or is not a boolean.
401 UnauthorizedMissing or invalid bearer token.
403 ForbiddenAuthenticated user is not the project owner.
404 Not FoundNo project exists with the given ID.

Build docs developers (and LLMs) love

Get started for freeTalk to us