Skip to main content
POST
Check the uploads and files, then start the release's review

Authorizations

Authorization
string
header
required

An API key (pch_...) or the token from pch login.

Path Parameters

owner
string
required
Example:

"patch"

slug
string
required
Example:

"demo-mod"

version
string
required
Example:

"0.1.0"

Response

The submitted release

id
string<uuid>
required
project
string
required
version
string
required
channel
enum<string>
required
Available options:
dev,
private,
unlisted,
public
status
enum<string>
required

draft, then checking (file checks). A browser game is testing until a test on its creator's PC passes, then cloud_review, then published. A mod goes to cloud_review, then in_review (a staff member), then published. Any step can end in rejected.

Available options:
draft,
checking,
testing,
cloud_review,
in_review,
published,
rejected,
yanked,
quarantined
kind
enum<string>
required
Available options:
web_game,
mod,
crossover_mod,
remix
trust_tier
enum<string>
required

What the release can do on the player's PC, worked out from its recipe and files: runs sandboxed in Patch, changes game files only, or runs code. Drives the consent sheet and review.

Available options:
sandboxed,
game_files_only,
runs_code
changelog
string | null
required
recipe
object | null
required

The release's recipe with its defaults filled in (https://patch.gg/schemas/recipe/v1.json). Null for releases made before recipes.

manifest
object | null
required

Deprecated: the patch.json of releases made before recipes, else null.

created_at
string
required
submitted_at
string | null
required
published_at
string | null
required