DEdefaulr
Groups

Update a group member

Changed on

Update the role of an existing member of a group, for example to promote them to a group admin or demote them back to a regular member.

post/groups.update_user

Request

  • Base URL
    https://app.getoutline.com/api
  • URL
    https://app.getoutline.com/api/groups.update_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 whose membership should be updated

permission'member' | 'admin' required

The permission the user should have within the group

Response

OK

Example response

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

Changes

  • c09b7940e788Revision changes
    • info

      added the optional property /// to the response with the status

  • 527f5b8079a2Revision changes
    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status