FAfamilysearch
Groups

Update Group

A user tree group is represented as a Gedcomx Group.

post/groups/{groupid}

Request

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

Path parameters

groupidstring required

The id of the user tree group to update. To find group IDs, see <a href="/reference/getgroups" target="_blank">Read User's Groups</a>.

Headers

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

Specifies the media type of the entity-body sent to the server in the request.

Request body

Example request

{
  "groups": [
    {
      "name": "Good Ship Zion Immigrant Society",
      "description": "Trees for those who immigrated on the various Good Ship Zion voyages",
      "codeOfConduct": "Please be respectful of others and their work"
    }
  ]
}

Response

The update was successful.

Changes

No recorded changes to this operation across all 1 revision of this API.