DEdefaulr
Groups

Update a group

Changed on

Update an existing group's name. The group is identified by its unique identifier.

post/groups.update

Request

  • Base URL
    https://app.getoutline.com/api
  • URL
    https://app.getoutline.com/api/groups.update
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://app.getoutline.com/oauth/authorize
      Token URL: https://app.getoutline.com/oauth/token scopes: read, write

Request body

idstring uuid required
namestring required
iconstring nullable

An icon or emoji to use as the group icon.

colorstring nullable

The color of the group icon in hex format.

Example request

{
  "name": "Designers"
}

Response

OK

Example response

{
  "data": {
    "name": "Engineering",
    "memberCount": 11
  },
  "policies": [
    {
      "abilities": {
        "read": true,
        "update": true,
        "delete": false
      }
    }
  ]
}

Changes

  • 527f5b8079a2Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • cd18cbbc1706Revision changes
    • warning

      the request property's maxLength was set to 255