Create User Tree

post

https://apibeta.familysearch.org/platform/trees

A user tree is represented as a GedcomX FamilySearch extension {@code Tree}.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The user tree to be created.

trees

array of objects

required

length between 1 and 1

Array containing the user tree to create.

trees*

name

string

required

The name of the user tree

description

string

A description of the user tree (optional)

groupIds

array of strings

required

length between 1 and 1

Array containing the group ID to associate with the user tree. To find group IDs, see Read User's Groups, or Create Group to create a new group.

groupIds*

ownerAccess

string

enum

Third-party access level for the tree owner (optional). Defaults to CompanyApp if not provided.

Allowed:

groupAccess

string

enum

Third-party access level for the tree group (optional). Defaults to None if not provided.

Allowed:

allAccess

string

enum

Third-party access level for all users (optional). Defaults to groupAccess if not provided.

Allowed:

Headers

Content-Type

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 was successful.

429

The request was throttled.

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here!