FAfamilysearch
Relationships

Create Relationship

Create a couple relationship or parent and child relationships.

post/tree/relationships

Request

  • Base URL
    https://apibeta.familysearch.org/platform
  • URL
    https://apibeta.familysearch.org/platform/tree/relationships
  • Auth
    HTTP bearer

Headers

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

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

X-Reasonstring

The reason for creating the relationship.

Request body

OR

Example request

{
  "relationships": [
    {
      "type": "http://gedcomx.org/Couple",
      "facts": [
        {
          "type": "http://gedcomx.org/Marriage",
          "date": {
            "original": "June 1800"
          },
          "place": {
            "original": "Provo, Utah, Utah, United States"
          },
          "attribution": {
            "changeMessage": "message"
          }
        }
      ]
    }
  ],
  "childAndParentsRelationships": [
    {
      "parent1Facts": [
        {
          "type": "http://gedcomx.org/AdoptiveParent",
          "attribution": {
            "changeMessage": "message"
          }
        }
      ],
      "parent2Facts": [
        {
          "type": "http://gedcomx.org/BiologicalParent",
          "attribution": {
            "changeMessage": "message"
          }
        }
      ]
    }
  ]
}

Response

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

Changes

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