Sign in

v19

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-037759134.1 KB
projects

Modify a project

patch/project/{id|slug}

Request body

slugstring

The slug of a project, used for vanity URLs. Regex: ^[\w!@$()`.+,"\-']{3,64}$

titlestring

The title or name of the project

descriptionstring

A short description of the project

categoriesstring[]

A list of the categories that the project has

client_side'required' | 'optional' | 'unsupported' | 'unknown'

The client side support of the project

server_side'required' | 'optional' | 'unsupported' | 'unknown'

The server side support of the project

bodystring

A long form description of the project

status'approved' | 'archived' | 'rejected' | 'draft' | 'unlisted' | 'processing' | 'withheld' | 'scheduled' | 'private' | 'unknown'

The status of the project

requested_status'approved' | 'archived' | 'unlisted' | 'private' | 'draft' nullable

The requested status when submitting for review or scheduling the project for release

additional_categoriesstring[]

A list of categories which are searchable but non-primary

issues_urlstring nullable

An optional link to where to submit bugs or issues with the project

source_urlstring nullable

An optional link to the source code of the project

wiki_urlstring nullable

An optional link to the project's wiki page or other relevant information

discord_urlstring nullable

An optional invite link to the project's discord

license_idstring

The SPDX license ID of a project

license_urlstring nullable

The URL to this license

moderation_messagestring nullable

The title of the moderators' message for the project

moderation_message_bodystring nullable

The body of the moderators' message for the project

Example request

{
  "slug": "my_project",
  "title": "My Project",
  "description": "A short description",
  "categories": [
    "technology",
    "adventure",
    "fabric"
  ],
  "client_side": "required",
  "server_side": "optional",
  "body": "A long body describing my project in detail",
  "status": "approved",
  "additional_categories": [
    "technology",
    "adventure",
    "fabric"
  ],
  "issues_url": "https://github.com/my_user/my_project/issues",
  "source_url": "https://github.com/my_user/my_project",
  "wiki_url": "https://github.com/my_user/my_project/wiki",
  "discord_url": "https://discord.gg/AaBbCcDd",
  "donation_urls": [
    {
      "id": "patreon",
      "platform": "Patreon",
      "url": "https://www.patreon.com/my_user"
    }
  ],
  "license_id": "LGPL-3.0-or-later"
}

Response

Expected response to a valid request