---
title: "Add user to group"
method: POST
path: "/groups/{id}/members"
tags: ["Groups"]
---

# Add user to group

`POST /groups/{id}/members`

## Request

- Base URL: `/v1` (relative, and the document’s source URL is not known)
- URL: `/v1/groups/{id}/members`
- Auth: API key in header `Authorization`

Adds a user to an existing group in Cognito

## Path parameters

- `id` string, required

## Request body

- object
  - `user_id` string, required

## Response `200`

User added to group

- Group: A group in the user pool
  - `id` string: The group ID
  - `name` string: The group name
  - `precedence` integer: The priority of the group
  - `created` string, date-time: The date the group was created
  - `last_modified_date` string, date-time
  - `role_arn` string
  - `user_pool_id` string

## Other responses

- `400`: Request rejected due to invalid parameters supplied
- `401`: Authentication information is missing or invalid
- `500`: Failed to process the request due to an internal error

---

[API](https://skmtc.dev/office-of-national-statistics/apis/identity-api.md) - [All operations](https://skmtc.dev/office-of-national-statistics/apis/identity-api/llms.txt) - [OpenAPI document](https://skmtc.dev/office-of-national-statistics/apis/identity-api/revisions/6472459b6b03?raw)