GuidesAPI ReferenceChangelogHelp
API Reference

Create Group

post
https://apibeta.familysearch.org/platform/groups

Create a user tree group. A user tree group is represented as a GedcomX FamilySearch extension Group.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

To create a user tree group, ensure the group is in the 'groups' attribute of the FamilySearchPlatform object. The user tree group must have a name. The group id and tree ids fields are ignored. All other fields are optional.

groups
array of objects
required
length between 1 and 1

Array containing the user tree group to create.

groups*
string
required

The name of the user tree group

string

A description of the user tree group (optional)

string

The code of conduct for the user tree group (optional)

Headers
string
enum
required

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

Allowed:
Responses
201

The creation of the user tree group was successful. Expect an X-Entity-Id header specifying the ID of the new group and a Location header containing the URL for the new group.

429

The request was throttled.

Updated 12 days ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here!

Updated 12 days ago