FAfamilysearch
Relationships

Update Genealogies Relationship

Update a genealogies relationship. The Relationship resource provides the interface to add or update specific facts attached to a genealogies relationship.

Important: Couple relationships for FamilySearch Genealogies require person1 to be male and person2 to be female.

post/genealogies/persons/{pid}/relationships/{cid}

Request

  • Base URL
    https://apibeta.familysearch.org/platform
  • URL
    https://apibeta.familysearch.org/platform/genealogies/persons/{pid}/relationships/{cid}
  • Auth
    HTTP bearer

Path parameters

pidstring required

The ID of the genealogies person to be updated. To find genealogies person IDs, see <a href="/reference/readgenealogiespersons" target="_blank">Read Genealogies Persons</a>.

cidstring required

The ID of the genealogies relationship to be updated. To find genealogies relationship IDs, see <a href="/reference/readgenealogiesperson" target="_blank">Read Genealogies Person</a>.

Headers

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

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

X-Reasonstring

Header giving the reason for updating the genealogies relationship.

Request body

Example request

{
  "relationships": [
    {
      "facts": [
        {
          "type": "http://gedcomx.org/Marriage",
          "date": {
            "original": "3 Apr 1836",
            "formal": "+1836"
          },
          "place": {
            "original": "Moscow, Russia"
          },
          "attribution": {
            "changeMessage": "message"
          }
        }
      ]
    }
  ]
}

Response

The successful update contained a single genealogies conclusion. Expect the id of the genealogies conclusion in the 'Location' header.

Changes

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