Update Pull Request settings¶

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "approval_required_reviewers_enable": {
      "description": "Whether to enable the approval-required reviewers feature",
      "type": "boolean"
    },
    "approval_required_reviewers": {
      "description": "Number of approvers required (minimum reviewer count); value range 0~5; pass 0 to disable the reviewer feature",
      "type": "integer",
      "minimum": 0,
      "maximum": 5
    },
    "only_allow_merge_if_all_discussions_are_resolved": {
      "description": "Merge only when all review issues are resolved",
      "type": "boolean"
    },
    "only_allow_merge_if_pipeline_succeeds": {
      "description": "Whether merging is allowed only after the pipeline succeeds",
      "type": "boolean"
    },
    "disable_merge_by_self": {
      "description": "Prohibit merging your own merge requests",
      "type": "boolean"
    },
    "can_force_merge": {
      "description": "Allow administrators to force merge",
      "type": "boolean"
    },
    "add_notes_after_merged": {
      "description": "Allow continued code review and comments after the merge request is merged",
      "type": "boolean"
    },
    "mark_auto_merged_mr_as_closed": {
      "description": "Whether to mark the state of automatically merged MRs as closed",
      "type": "boolean"
    },
    "can_reopen": {
      "description": "Whether a closed merge request can be reopened",
      "type": "boolean"
    },
    "delete_source_branch_when_merged": {
      "description": "Whether to delete the source branch when merging; the source branch is deleted by default",
      "type": "boolean"
    },
    "disable_squash_merge": {
      "description": "Prohibit Squash merge",
      "type": "boolean"
    },
    "auto_squash_merge": {
      "description": "Enable Squash merge by default for new merge requests",
      "type": "boolean"
    },
    "merge_method": {
      "description": "Merge mode (choose one of three): merge via merge commit (merge); merge via merge commit recording a semi-linear history (rebase_merge); fast-forward merge (ff)",
      "type": "string",
      "enum": ["merge", "rebase_merge", "ff"]
    },
    "squash_merge_with_no_merge_commit": {
      "description": "Squash merge does not create a Merge node",
      "type": "boolean"
    },
    "merged_commit_author": {
      "description": "Generate the Merge Commit using the MR (merger/creator): pass merged_by to use the PR merger; pass created_by to use the PR creator",
      "type": "string",
      "enum": ["merged_by", "created_by"]
    },
    "approval_required_approvers": {
      "description": "Number of approvers required",
      "type": "integer",
      "maximum": 1000
    },
    "approval_approver_ids": {
      "description": "Project reviewers; user_ids separated by commas",
      "type": "string"
    },
    "approval_tester_ids": {
      "description": "Project testers; user_ids separated by commas",
      "type": "string"
    },
    "approval_required_testers": {
      "description": "Minimum number of testers that must pass",
      "type": "integer"
    },
    "is_check_cla": {
      "description": "Whether to validate CLA",
      "type": "boolean"
    },
    "is_allow_lite_merge_request": {
      "description": "Whether lightweight Pull Requests are enabled",
      "type": "boolean"
    },
    "lite_merge_request_prefix_title": {
      "description": "Title prefix for lightweight PRs",
      "type": "string"
    },
    "close_issue_when_mr_merged": {
      "description": "When creating a Pull Request, select \"Close related issues after merge\" by default; this parameter has no effect when the \"Close related issues after merge\" option is disabled",
      "type": "boolean"
    },
    "forbidden_pr_related_issue_closed": {
      "description": "Prohibit a PR from being associated with a closed issue (when this is true, close_issue_when_mr_merged is forced to false)",
      "type": "boolean"
    }
  }
}

{
  "error": "invalid_request",
  "message": "The option Close associated issues after merging has been disabled."
}

{
  "error": "unauthorized",
  "message": "Missing or invalid access token"
}

curl -X PUT 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/pull_request_settings?access_token=<token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
    "merge_method": "merge",
    "disable_merge_by_self": false,
    "can_force_merge": true
  }'

// Native fetch (Node.js 18+ / browser)
const response = await fetch(
  "https://api.atomgit.com/api/v5/repos/<owner>/<repo>/pull_request_settings?access_token=<token>",
  {
    method: "PUT",
    headers: {
      "Accept": "application/json",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      merge_method: "merge",
      disable_merge_by_self: false,
      can_force_merge: true,
    }),
  }
);

if (!response.ok) {
  throw new Error(`Request failed: ${response.status}`);
}

const data = await response.json();
console.log(data);

import requests

resp = requests.put(
    "https://api.atomgit.com/api/v5/repos/<owner>/<repo>/pull_request_settings",
    params={"access_token": "<token>"},
    json={
        "merge_method": "merge",
        "disable_merge_by_self": False,
        "can_force_merge": True,
    },
    headers={"Accept": "application/json"},
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

{
  "merge_request_setting": {
    "id": 1431,
    "project_id": 2745002,
    "disable_merge_by_self": false,
    "created_at": "2024-03-28T10:04:13.523+08:00",
    "updated_at": "2024-11-13T21:30:45.261+08:00",
    "can_force_merge": false,
    "disable_squash_merge": true,
    "approval_required_reviewers": 0,
    "approval_required_approvers": 0,
    "add_notes_after_merged": false,
    "merged_commit_author": "merged_by",
    "mark_auto_merged_mr_as_closed": false,
    "delete_source_branch_when_merged": false,
    "auto_squash_merge": false,
    "squash_merge_with_no_merge_commit": false,
    "close_issue_when_mr_merged": false,
    "can_reopen": true,
    "is_check_cla": false,
    "approval_approvers": [],
    "approval_testers": [],
    "approval_required_testers": 0,
    "is_allow_lite_merge_request": false
  },
  "only_allow_merge_if_all_discussions_are_resolved": false,
  "only_allow_merge_if_pipeline_succeeds": false,
  "merge_method": "merge"
}