Documentation

Modify Project

POST /projects/modify

Modifies a project's details.

Request Body

Field Type Required Description
project_id string Yes Project ID

| active | boolean | No | Whether the project is active or not | | name | string | No | Project name | | description | string | No | Project description | | status | string | No | Project status (one of: active, inactive) | | status_details | string | No | Additional project status details | | user_add_email_message | string | No | Email message sent to users when added to the project | | hidden_note | string | No | Hidden note for site administrators (requires moderator permission) | | start_date | string or null | No | Change or clear the project’s start date. | | end_date | string or null | No | Change or clear the project’s end date. | | force_daily_digest_emails | boolean | No | Require daily digest emails for this project. |

Response

Success Response (200 OK)

data contains the updated project.

Error Responses

  • 400 Bad Request: Invalid request
  • 422 Unprocessable Entity: Request fields fail schema validation
  • 401 Unauthorized: Authentication failed
  • 403 Forbidden: User does not have permission to modify this project
  • 404 Not Found: Project with the specified ID does not exist

See the Projects API overview for related endpoints.