Matches

Update Not-a-Match Declaration

Add or edit a not-a-match declaration, indicating that the two referenced persons are separate and distinct individuals and should not be merged together. This operation will fail if there already exists a not-a-match declaration for the person(s).A reason string can be provided indicating why the user believes the two persons to be distinct individuals. The reason is sent as an 'X-Reason' value in the HTTP Headers on the request. This reason can have a maximum length of 2000 characters, and if the reason supplied is more than 2000 characters, the request will fail as an invalid request.

post/tree/persons/{pid}/not-a-match

Request

Base URL
https://apibeta.familysearch.org/platform
URL
https://apibeta.familysearch.org/platform/tree/persons/{pid}/not-a-match
Auth
HTTP bearer

Path parameters

pidstring required

The id of the person. Can be a person from the main FamilySearch tree or from a user tree. To find an example person ID, see <a href="/reference/searchtreepersons" target="_blank">Search Tree Persons</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

The header giving the reason for adding/removing a not-a-match declaration.

Request body

Example request

{
  "persons": [
    {
      "attribution": {
        "changeMessage": "message"
      }
    }
  ]
}

Response

The update was successful.

Changes

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