{% extends "docs/base.html" %} {% block docs_content %}

Update pull

Update pull content fields and optional refs.

Endpoints

PUT /api/v1/teams/{team_slug}/repos/{repo_slug}/pulls/{number}
PUT /api/v1/users/{username}/repos/{repo_slug}/pulls/{number}
Authenticated

Request

JSON body (all optional):

Changing refs has stricter permissions than editing title/body.

Usage

curl --request PUT \
  --header "Authorization: Bearer $PEARING_API_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{"title": "Feature x (updated)", "body": "Updated description."}' \
  "$PEARING_API_URL/v1/teams/platform/repos/website/pulls/42"

Success

200 OK with the updated pull record, including creator, merger, and closer actor fields where applicable.

{
  "uuid": "...",
  "number": 42,
  "source_repo": "alice/website-fork",
  "title": "Feature x (updated)",
  "body": "Updated description.",
  "status": "open",
  "updated_at": "2026-03-09T13:00:00Z"
}

Errors

Common auth errors are documented on the API overview page.

{% endblock %}