DEdefaulr
Groups

Add a group member

Changed on

This method allows you to add a user to the specified group.

post/groups.add_user

Request

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

Identifier for the group

userIdstring uuid required

Identifier for the user to add to the group

permission'member' | 'admin'

The permission level for the user within the group. When omitted for a new membership this defaults to member, and an existing membership's permission is left unchanged.

Response

OK

Example response

{
  "data": {
    "users": [
      {
        "name": "Jane Doe"
      }
    ],
    "groups": [
      {
        "name": "Engineering",
        "memberCount": 11
      }
    ],
    "groupMemberships": [
      {
        "createdBy": {
          "name": "Jane Doe"
        }
      }
    ]
  }
}

Changes