Link a pull request to an issue by hand

POST/api/issues/{issue_id}/pull-requests

createIssuePullRequestLink

Writes a `manual` link: the PR's own re-parse (description magic words and source branch name) never removes or re-kinds it, and a `fixes` link closes the issue when the PR merges, like a derived one. Overwrites an existing link for the pair, pinning a derived one as manual. Needs the issue-edit permission (team member or author, as `PATCH /api/issues/{issue_id}`) and read access to the PR's repository; a PR that is missing or unreadable is a 404, and a PR in another workspace than the issue is a 400.

Requires authentication using a bearer token or a session cookie — see tokens and scopes.

curl

curl -X POST 'https://neosource.dev/api/issues/ISSUE_ID/pull-requests' \
  -H 'Authorization: Bearer $NEOSOURCE_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"pr_id":"string","link_kind":"string"}'

fetch

fetch("https://neosource.dev/api/issues/ISSUE_ID/pull-requests", {
  method: "POST",
  headers: {
    Authorization: "Bearer $NEOSOURCE_TOKEN",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"pr_id":"string","link_kind":"string"}),
});

Path parameters

issue_idrequired: string

Request bodyrequired

application/json

CreateIssuePrLinkRequest

object

Body of `POST /api/issues/{issue_id}/pull-requests`: link a PR to the issue by hand. The link is `manual` — the PR's own re-parse never removes it.

link_kindrequired: IssuePrLinkKind
string
How a PR relates to an issue. `Fixes` links auto-transition the issue's status; `References` links are advisory backlinks only.
"fixes""references"
pr_idrequired: string
Id of the pull request to link. Must be in the issue's workspace and readable by the caller.

Responses

201Link written

application/json

IssuePrLinkResponse

object

created_atrequired: integerint64
created_byrequired: string
issue_idrequired: string
link_kindrequired: IssuePrLinkKind
string
How a PR relates to an issue. `Fixes` links auto-transition the issue's status; `References` links are advisory backlinks only.
"fixes""references"
originrequired: IssuePrLinkOrigin
string
Where an issue ↔ PR link came from — the `issue_pr_link_origin` Pg enum. `Derived` links are re-derived from the PR (description magic words and source branch name) on every create and description edit, which deletes and re-kinds them freely. `Manual` links were added from the issue side and are never touched by that pass; only an explicit unlink removes one.
"derived""manual"
pr_idrequired: string
pr_number: integer | nullint32
PR coordinates resolved at read time (route-layer enrichment on the issue-side listing) so the SPA can render `owner/repo#N` links. `None` on the PR-side listing or if the PR row went away.
pr_status: one of
PullRequestStatus
string
Lifecycle status of a pull request.
"open""merged""closed"
null
pr_title: string | null
repo_name: string | null
repo_owner: string | null

403Forbidden — one of: forbidden, needs_scope

application/json

one of

ErrorForbidden
NeedsScopeError
object
`403` body returned when a classic OAuth token is asked for something its granted scopes do not cover — an explicit private listing without `repo`, or the one-click GitHub mirror without `admin:public_key`. `scope` names the missing grant so the client can say exactly what the token lacks. There is no elevation route to widen it any more (a re-link goes through the GitHub App, whose tokens carry no scopes), so the client's answer is to say so, never to start a handshake.
errorrequired
string
Always `needs_scope` — this body exists to carry the extra fields that kind needs.
"needs_scope"
scoperequired
string
The provider scope to request via elevation (e.g. `"repo"`).

Standard errors

Bodies documented once for the whole API — see standard errors.

400Bad Request — one of: invalid_input
401Authentication required
404Not Found — one of: not_found
409Conflict — one of: already_exists, conflict, github_sync_active
429Rate limited — retry after the `Retry-After` header
500Internal server error
503Service temporarily unavailable / at capacity — retry after the `Retry-After` header
504Gateway timeout — the request exceeded the server's handling budget