Skip to content
GitmoapAPIBeta
Organizegroups
PUT/groups/{group_id}

Update a group

update_group
  • group:update
    A token needs the group:update scope: Update groups and group visibilityGranted by write_api.Every operation this scope unlocks
  • Audited · mutation

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

Changes any of the group's name, display name, description, avatar and visibility; fields left out keep their value. Maintainers and above may update a group; changing its visibility, or renaming an organization, needs an Owner. Visibility can be no wider than the parent group's and no narrower than any subgroup's or repository's directly inside it. Renaming changes the group's path and the path of everything beneath it, and is refused when the new path is taken. An organization's new name is checked as a new organization's is, except that a domain the organization has verified unlocks the name reserved for it; the name it gives up is held back for it for ninety days — for good once it has published a public repository or a package — and it may hold back at most five.

Parameters

Path
  • group_idGroupId (string · uuid)Group ID

Request body

application/json
  • avatarAvatarUrl (string) or nulloptional
  • descriptionstring or nulloptional
  • display_namestring or nulloptional
  • group_nameEntityName (string) or nulloptional
  • visibilityVisibilitypublicinternalprivateor nulloptional
Request body exampleSynthesized example
{}

Responses

200Group updatedapplication/json
  • created_atstring
  • created_byUserId (string · uuid)
  • full_pathFullPath (string)
  • group_idGroupId (string · uuid)
  • group_nameEntityName (string)
  • updated_atstring
  • visibilityVisibilitypublicinternalprivate
  • ancestor_group_idsarray of GroupId (string · uuid)optional
  • avatarstring or nulloptional
  • descriptionstring or nulloptional
  • display_namestring or nulloptional
  • parent_group_idGroupId (string · uuid) or nulloptional
200 exampleSynthesized example
{
"created_at": "2026-10-10T04:13:46Z",
"created_by": "b7e2d1c0-9f8e-4d7c-a6b5-c4d3e2f1a0b9",
"full_path": "acme/payments-api",
"group_id": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69",
"group_name": "payments-api",
"updated_at": "2026-10-13T10:45:05Z",
"visibility": "public",
"ancestor_group_ids": [
"4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69",
"4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69"
],
"avatar": "avatar-c8fc",
"description": "Renders each region as density contours of its operations.",
"display_name": "Lin Park",
"parent_group_id": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69"
}
400Invalid request or visibility exceeds parentapplication/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-8004",
"message": "Pin a page's payload to the build that rendered it"
}
}
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-c0f4",
"message": "Pin a page's payload to the build that rendered it"
}
}
403Forbidden (Owner required for a visibility change or an organization's rename), or the new name is reservedapplication/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
  • NAME_RESEMBLES_RESERVEDThe name looks like a name reserved for another organization; prove that organization's domain, or choose another name
  • PERMISSION_REQUIREDYou need a permission you do not hold here; the message names it
  • RESERVED_NAMESPACEThe name is reserved — for the platform, or for the organization that owns the domain the message names
  • 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-1633",
"message": "Stream pipeline status into the run header"
}
}
404Group not foundapplication/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-c829",
"message": "Label every synthesized example"
}
}
409New path already taken, the name is held back, or the organization holds back as many former names as it mayapplication/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
  • NAME_HOLD_LIMITThe organization already holds back as many of its former names as it may; rename it back to one of them, or ask support to release one
  • NAME_RETIREDAnother organization gave the name up recently, or published under it, so it is held back; choose another name
  • 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-97fe",
"message": "Inline scalar newtypes but keep their brand"
}
}

CLI

gitmoap groups update

  • --group-ididGroup ID (id or group path)
  • --avatarstringoptional
  • --descriptionstringoptional
  • --display-namestringoptional
  • --group-namestringoptional
  • --visibilitypublic | internal | privateoptional

Used in these guides