Create Relationship

post

https://apibeta.familysearch.org/platform/tree/relationships

Create a relationship.

Body Params

Gedcomx object containing the relationship to create

relationships

array of objects

required

length ≥ 1

Array of couple relationships to create. Each relationship connects two spouses.

relationships*

type

string

required

The type of the relationship

person1

object

required

The first person in the couple relationship (typically male for FamilySearch Family Tree)

person2

object

required

The second person in the couple relationship (typically female for FamilySearch Family Tree)

facts

array of objects

Array of facts about the couple relationship (e.g., marriage facts)

facts

childAndParentsRelationships

array of objects

Array of child-and-parents relationships to create. Each relationship connects a child to up to two parents.

childAndParentsRelationships

Headers

Content-Type

string

enum

required

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

Allowed:

X-Reason

string

The reason for creating the relationship.

Responses

201

The creation of the relationship was successful. Expect a Location header specifying the link to the created relationship.

429

The request was throttled.

Language

Credentials

Bearer

Response

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