Skip to content
Modrinth Documentation

Modify a project

PATCH
/project/{id|slug}

Authorizations

Parameters

Path Parameters

id|slug
required
string
[
  "AABBCCDD",
  "my_project"
]

The ID or slug of the project

Request Body

Modified project fields

object
slug

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

string
my_project
title

The title or name of the project

string
description

A short sentence summarizing the project, no more than a sentence or two.

string
body

A long form description of the project

string
A long body describing my project in detail
categories

A list of the featured categories that the project has.

Array<string>
[
  "technology",
  "adventure",
  "fabric"
]
additional_categories

A list of additional categories that the project also has. These are supplementary to the featured categories, and does not include them again.

Array<string>
[
  "technology",
  "adventure",
  "fabric"
]
status

The status of the project

string
Allowed values: approved archived rejected draft unlisted processing withheld scheduled private unknown 
approved
requested_status

The requested status when submitting for review or scheduling the project for release. Approved status refers to “Public” visibility.

string
nullable
Allowed values: approved archived unlisted private draft
issues_url

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

string
nullable 
https://github.com/modrinth/code/issues
source_url

An optional link to the source code of the project

string
nullable 
https://github.com/modrinth/code
wiki_url

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

string
nullable 
https://github.com/modrinth/code/wiki
discord_url

An optional invite link to the project’s discord.

string
nullable 
https://discord.gg/modrinth
donation_urls

A list of donation links for the project

Array<object>
object
id

The ID of the donation platform

string
patreon
platform

The donation platform this link is to

string
Patreon
url

The URL of the donation platform and user

string
https://www.patreon.com/my_user
client_side

Deprecated - use environment instead.

string
Allowed values: required optional unsupported 
required
server_side

Deprecated - use environment instead.

string
Allowed values: required optional unsupported 
optional
license_id

The SPDX license ID of a project

string
LGPL-3.0-or-later
license_url

The URL to this license

string
nullable
moderation_message

The title of the moderators’ message for the project

string
nullable
moderation_message_body

The body of the moderators’ message for the project

string
nullable

Responses

204

Expected response to a valid request

401

Incorrect token scopes or no authorization to access the requested item(s)

object
error
required

The name of the error

string
unauthorized
description
required

The contents of the error

string
Authentication Error: Invalid Authentication Credentials

404

The requested item(s) were not found or no authorization to access the requested item(s)