---
title: "Update Group"
method: POST
path: "/groups/{groupid}"
tags: ["Groups"]
---

# Update Group

`POST /groups/{groupid}`

## Request

- Base URL: `https://apibeta.familysearch.org/platform`
- URL: `https://apibeta.familysearch.org/platform/groups/{groupid}`
- Auth: HTTP bearer

A user tree group is represented as a Gedcomx [`Group`](#schema-Group).

## Path parameters

- `groupid` string, required

## Headers

- `Content-Type` 'application/x-fs-v1+json', required

## Request body

- UpdateGroup
  - `groups` union[], required: Array containing the user tree group to update. Only one group may be updated at a time. See <a href="https://developers.familysearch.org/main/docs/json-schema#group" target="_blank">Group Schema (JSON)</a>
    - union
      - object
        - `name` string, required: The name of the user tree group. Removing the value for name is not allowed.
        - `description` string: A description of the user tree group. Provide an empty string to remove the existing description.
        - `codeOfConduct` string: The code of conduct for the user tree group. Provide an empty string to remove the existing code of conduct.
      - object
        - `name` string: The name of the user tree group. Removing the value for name is not allowed.
        - `description` string, required: A description of the user tree group. Provide an empty string to remove the existing description.
        - `codeOfConduct` string: The code of conduct for the user tree group. Provide an empty string to remove the existing code of conduct.
      - object
        - `name` string: The name of the user tree group. Removing the value for name is not allowed.
        - `description` string: A description of the user tree group. Provide an empty string to remove the existing description.
        - `codeOfConduct` string, required: The code of conduct for the user tree group. Provide an empty string to remove the existing code of conduct.

## Response `204`

The update was successful.

## Other responses

- `404`: The requested user tree group does not exist.
- `410`: The requested user tree group has been deleted.
- `429`: The request was throttled.

---

[API](https://skmtc.dev/familysearch/apis/user-tree-endpoints.md) - [All operations](https://skmtc.dev/familysearch/apis/user-tree-endpoints/llms.txt) - [OpenAPI document](https://skmtc.dev/familysearch/apis/user-tree-endpoints/revisions/8ae07006966b?raw)