Skip to content
GitmoapAPIBeta
Planissues
PUT/repositories/{repo_id}/issue-settings

Update a repository's issue settings

update_repo_issue_settings
  • issue_settings:manage
    A token needs the issue_settings:manage scope: Manage issue settingsGranted by write_api, write_repository.Every operation this scope unlocks
  • Audited · mutation

    x-gitmoap-audit: {"kind":"audited","arg":"mutation"}

Changes what the repository stores and returns it: only the fields you send change, a field sent as null is cleared so it is inherited again, and the stored values apply only while override_group_settings is on. A status set needs one unarchived open status marked as the default and at least one unarchived done status, and an existing status cannot change category — add a new status and archive the old one. Maintainers and above may do this; an empty body is refused.

Parameters

Path
  • repo_idRepositoryId (string · uuid)Repository ID

Request body

application/json
  • anchor_drift_actionAnchorDriftActionflagcommentnoneor nulloptionalWhat happens when an anchored region of code changes beyond recognition.
  • auto_close_on_verifiedboolean or nulloptional
  • auto_reopen_on_orphaned_closeboolean or nulloptional
  • auto_reopen_on_regressionboolean or nulloptional
  • binding_change_resets_evidenceboolean or nulloptional
  • blocked_by_blocks_closeboolean or nulloptional
  • close_on_commit_keywordboolean or nulloptional
  • closing_branchesarray of BranchPattern (string) or nulloptional
  • default_assignee_from_codeownersboolean or nulloptional
  • default_issue_typeWorkItemTypeepicstorybugtaskspikechoreincidentsub_taskor nulloptionalThe kind of work item. The type decides where an item may live (a group or a repository), which types it may have as children, and which fields it accepts.
  • on_branch_createdAutoTransition or nulloptional
  • on_mr_closedAutoTransition or nulloptional
  • on_mr_mergedAutoTransition or nulloptional
  • on_mr_openedAutoTransition or nulloptional
  • override_group_settingsboolean or nulloptional
  • public_issue_filingboolean or nulloptional
  • require_verified_criteria_to_closeboolean or nulloptional
  • statusesarray of StatusDef or nulloptional
    • The StatusDef schema
    • categoryStatusCategorytriagetodoin_progressin_reviewblockeddonecancelledThe category this status belongs to. It cannot be changed after the status is created: to move work to a different category, add a status and archive this one.
    • namestring
    • status_idStatusId (string)
    • archivedbooleanoptional
    • colorLabelColor (string) or nulloptional
    • is_defaultbooleanoptionalThe status new issues land in. Exactly one status in a set carries it, and it must be open.
  • todo_ignore_pathsarray of string or nulloptional
  • todo_policyTodoPolicyignoreindexpromoteor nulloptionalWhat a bare // TODO: in a push becomes.
  • todo_promote_typeWorkItemTypeepicstorybugtaskspikechoreincidentsub_taskor nulloptionalThe kind of work item. The type decides where an item may live (a group or a repository), which types it may have as children, and which fields it accepts.
  • transitionsTransitionTable or nulloptional
Request body exampleSynthesized example
{}

Responses

200What this scope now storesapplication/json
  • anchor_drift_actionAnchorDriftActionflagcommentnoneor nulloptionalWhat happens when an anchored region of code changes beyond recognition.
  • auto_close_on_verifiedboolean or nulloptional
  • auto_reopen_on_orphaned_closeboolean or nulloptional
  • auto_reopen_on_regressionboolean or nulloptional
  • binding_change_resets_evidenceboolean or nulloptional
  • blocked_by_blocks_closeboolean or nulloptional
  • close_on_commit_keywordboolean or nulloptional
  • closing_branchesarray of BranchPattern (string) or nulloptional
  • default_assignee_from_codeownersboolean or nulloptional
  • default_issue_typeWorkItemTypeepicstorybugtaskspikechoreincidentsub_taskor nulloptionalThe kind of work item. The type decides where an item may live (a group or a repository), which types it may have as children, and which fields it accepts.
  • on_branch_createdAutoTransition or nulloptional
  • on_mr_closedAutoTransition or nulloptional
  • on_mr_mergedAutoTransition or nulloptional
  • on_mr_openedAutoTransition or nulloptional
  • override_group_settingsboolean or nulloptional
  • public_issue_filingboolean or nulloptional
  • require_verified_criteria_to_closeboolean or nulloptional
  • statusesarray of StatusDef or nulloptional
    • The StatusDef schema
    • categoryStatusCategorytriagetodoin_progressin_reviewblockeddonecancelledThe category this status belongs to. It cannot be changed after the status is created: to move work to a different category, add a status and archive this one.
    • namestring
    • status_idStatusId (string)
    • archivedbooleanoptional
    • colorLabelColor (string) or nulloptional
    • is_defaultbooleanoptionalThe status new issues land in. Exactly one status in a set carries it, and it must be open.
  • todo_ignore_pathsarray of string or nulloptional
  • todo_policyTodoPolicyignoreindexpromoteor nulloptionalWhat a bare // TODO: in a push becomes.
  • todo_promote_typeWorkItemTypeepicstorybugtaskspikechoreincidentsub_taskor nulloptionalThe kind of work item. The type decides where an item may live (a group or a repository), which types it may have as children, and which fields it accepts.
  • transitionsTransitionTable or nulloptional
200 exampleSynthesized example
{
"anchor_drift_action": "flag",
"auto_close_on_verified": false,
"auto_reopen_on_orphaned_close": false,
"auto_reopen_on_regression": false,
"binding_change_resets_evidence": false,
"blocked_by_blocks_close": false,
"close_on_commit_keyword": false,
"closing_branches": [
"closing-branches-9843"
],
"default_assignee_from_codeowners": false,
"default_issue_type": "epic",
"on_branch_created": "disabled",
"on_mr_closed": "disabled",
"on_mr_merged": "disabled",
"on_mr_opened": "disabled",
"override_group_settings": false,
"public_issue_filing": false,
"require_verified_criteria_to_close": false,
"statuses": [
{
"category": "triage",
"name": "payments-api",
"status_id": "9ef1f9b6-768d-4fce-bf5e-66008ce1aaf5"
}
],
"todo_ignore_paths": [
"todo-ignore-paths-dd9d",
"todo-ignore-paths-bf57"
],
"todo_policy": "ignore",
"todo_promote_type": "epic",
"transitions": {
"table": {}
}
}
400Empty body, or an invalid status setapplication/json
Error codes
  • BAD_REQUESTThe request is malformed: a parameter or a body field is not a well-formed value of its type
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
400 exampleSynthesized example
{
"error": {
"code": "code-485a",
"message": "Stream pipeline status into the run header"
}
}
401Unauthenticated — no credential, or an invalid oneapplication/json
Error codes
  • UNAUTHORIZEDNo credential was sent, or the one sent is invalid, expired or revoked
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
401 exampleSynthesized example
{
"error": {
"code": "code-cda1",
"message": "Draw the region map from operation density"
}
}
403Forbidden — the caller's access level or token scope is insufficientapplication/json
Error codes
  • FORBIDDENYou are signed in but may not do this here; reason names the permission or the rule that refused it
  • INSUFFICIENT_SCOPEThe access token lacks the scope this operation needs; required_scope names it
  • PERMISSION_REQUIREDYou need a permission you do not hold here; the message names it
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
403 exampleSynthesized example
{
"error": {
"code": "code-bd2c",
"message": "Label every synthesized example"
}
}
404Not found — or found and private, which is masked as absentapplication/json
Error codes
  • NOT_FOUNDThe resource does not exist — or exists and you cannot see it: a private resource you have no access to answers exactly as an absent one does
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
404 exampleSynthesized example
{
"error": {
"code": "code-c6ab",
"message": "Inline scalar newtypes but keep their brand"
}
}
409The request conflicts with the resource's current state; `reason` says howapplication/json
Error codes
  • CONFLICTThe request conflicts with the resource's current state; reason says how
  • LEGAL_ACCEPTANCE_REQUIREDAccept the current Terms of Service before changing anything; reading stays open
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
409 exampleSynthesized example
{
"error": {
"code": "code-7752",
"message": "Label every synthesized example"
}
}

CLI

gitmoap issues update-repo-settings

  • --repo-ididRepository ID (id or owner/repo path)
  • --anchor-drift-actionflag | comment | noneoptional
  • --auto-close-on-verifiedflagoptional
  • --auto-reopen-on-orphaned-closeflagoptional
  • --auto-reopen-on-regressionflagoptional
  • --binding-change-resets-evidenceflagoptional
  • --blocked-by-blocks-closeflagoptional
  • --close-on-commit-keywordflagoptional
  • --closing-branchesjsonoptional
  • --default-assignee-from-codeownersflagoptional
  • --default-issue-typeepic | story | bug | task | spike | chore | incident | sub_taskoptional
  • --on-branch-createdjsonoptional
  • --on-mr-closedjsonoptional
  • --on-mr-mergedjsonoptional
  • --on-mr-openedjsonoptional
  • --override-group-settingsflagoptional
  • --public-issue-filingflagoptional
  • --require-verified-criteria-to-closeflagoptional
  • --statusesjsonoptional
  • --todo-ignore-pathsjsonoptional
  • --todo-policyignore | index | promoteoptional
  • --todo-promote-typeepic | story | bug | task | spike | chore | incident | sub_taskoptional
  • --transitionsjsonoptional

Used in these guides