FAfamilysearch
Matches

Delete Not-a-Match Declaration

Delete a not-a-match declaration means that the primary person could be a match with the given person. A reason string can be provided indicating why the user believes the two persons may no longer be considered as distinct individuals. The reason is sent as an 'X-Reason' header on the request. This reason should have a maximum length of 2000 characters, and if the reason supplied is too long, the request may fail as a bad request.

delete/tree/persons/{pid}/not-a-match/{nmid}

Request

  • Base URL
    https://apibeta.familysearch.org/platform
  • URL
    https://apibeta.familysearch.org/platform/tree/persons/{pid}/not-a-match/{nmid}
  • 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>.

nmidstring required

The non-match id of the not-a-match declaration to be deleted. To find not-a-match declaration IDs, see <a href="/reference/readpersonnotamatches" target="_blank">Read Not-a-Match Declarations</a>.

Headers

X-Reasonstring

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

Response

The delete was successful.

Changes

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