FAfamilysearch
Relationships: Couple

Update Couple Relationship

Add or update specific facts attached to a couple. FamilySearch also allows you to update the persons in a couple relationship.

post/tree/couple-relationships/{crid}

Request

  • Base URL
    https://apibeta.familysearch.org/platform
  • URL
    https://apibeta.familysearch.org/platform/tree/couple-relationships/{crid}
  • Auth
    HTTP bearer

Path parameters

cridstring required

The id of the couple relationship. To find couple relationship IDs, see <a href="/reference/readpersonfamilies" target="_blank">Read Families</a>.

Headers

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

Specifies the media type(s) that the client is willing to accept in the response.

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

The reason for the couple relationship update.

Request body

Example request

{
  "relationships": [
    {
      "facts": [
        {
          "type": "http://gedcomx.org/Marriage",
          "date": {
            "original": "June 1800",
            "formal": "+1800-06"
          },
          "place": {
            "original": "Provo, Utah, Utah, United States"
          },
          "attribution": {
            "changeMessage": "Message"
          }
        }
      ]
    }
  ]
}

Response

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

Changes

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