Skip to main content
POST
Open a pull request on a connected repo

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"

Body

application/json
head
string
required

The branch to merge, on the same repo

Pattern: ^(?![-/])(?!.*\.\.)[\w.\-/]{1,200}$
Example:

"sky-boost"

title
string
required
Required string length: 1 - 256
Example:

"Add the sky boost"

base
string

The branch it goes into: the repo's default branch, left out

Pattern: ^(?![-/])(?!.*\.\.)[\w.\-/]{1,200}$
Example:

"main"

body
string

What it does, in GitHub's Markdown

Maximum string length: 60000

Response

It was open already

number
integer
required
Example:

12

url
string<uri>
required

Its page on GitHub

title
string
required
head
string
required

The branch it's from

Example:

"sky-boost"

base
string
required

The branch it goes into

Example:

"main"

state
enum<string>
required
Available options:
open,
closed,
merged
merged_at
string | null
required

When it merged, or null

mergeable
boolean | null
required

Whether it can merge as it stands, or null while GitHub works that out

opened
enum<boolean>
required
Available options:
false