---
title: "Add a group member"
method: POST
path: "/groups.add_user"
tags: ["Groups"]
---

# Add a group member

`POST /groups.add_user`

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

## Request body

- object
  - `id` string, uuid, required
  - `userId` string, uuid, required

## Response `200`

OK

- object
  - `data` object
    - `users` User[]
      - `id` string, uuid — Unique identifier for the object.
      - `name` string — The name of this user, it is migrated from Slack or Google Workspace when the SSO connection is made but can be changed if neccessary.
      - `avatarUrl` string, uri — The URL for the image associated with this user, it will be displayed in the application UI and email notifications.
      - `email` string, email — The email associated with this user, it is migrated from Slack or Google Workspace when the SSO connection is made but can be changed if neccessary.
      - `role` 'admin' | 'member' | 'viewer' | 'guest'
      - `isSuspended` boolean — Whether this user has been suspended.
      - `lastActiveAt` string, date-time — The last time this user made an API request, this value is updated at most every 5 minutes.
      - `createdAt` string, date-time — The date and time that this user first signed in or was invited as a guest.
    - `groups` Group[]
      - `id` string, uuid — Unique identifier for the object.
      - `name` string — The name of this group.
      - `memberCount` number — The number of users that are members of the group
      - `createdAt` string, date-time — The date and time that this object was created
      - `updatedAt` string, date-time — The date and time that this object was last changed
    - `groupMemberships` Membership[]
      - `id` string — Unique identifier for the object.
      - `userId` string, uuid — Identifier for the associated user.
      - `collectionId` string, uuid — Identifier for the associated collection.
      - `permission` 'read' | 'read_write'

## Other responses

- `400` — The request failed one or more validations.
- `401` — The API key is missing or otherwise invalid.
- `403` — The current API key is not authorized to perform this action.
- `404` — The specified resource was not found.
- `429` — The request was rate limited.

---

[API](https://skmtc.net/defaulr/apis/outline-api.md) · [All operations](https://skmtc.net/defaulr/apis/outline-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/defaulr/outline-api/revisions/fdf2ec9c9df4/schema)