DEdefaulr
Groups

Create a group

Changed on

Create a new group with the specified name. Groups can be used to organize users and assign collection permissions to multiple users at once.

post/groups.create

Request

  • Base URL
    https://app.getoutline.com/api
  • URL
    https://app.getoutline.com/api/groups.create
  • 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

namestring required
descriptionstring nullable

A short description of the group.

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 2000

    • warning

      the request property's maxLength was set to 255