v1

latestOpenAPI 3.0.1Apache 2.02026-07-2420454370.2 KB

Matches

Update Match Resolution

Certification Required

Add or modify a match resolution for the given tree person id. The status parameter should indicate if the match is Pending, Accepted, or Rejected. The body of the POST should contain a gedcomx document with a single record persona id for the match resolution. If an Accepted or Rejected match resolution declaration already exists for the given tree person id, an error will be returned. The current resolution should first be reset to Pending, then a new match resolution may be set.

A reason string should be provided indicating why the user believes this is or is not a match.

post/tree/persons/{pid}/matches

Path parameters

pidstring required

The ID of the person the match is to be added to or modified. 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>.

Query parameters

collection'records' | 'tree' | 'user_trees' | 'cet'

The name of the collection in which to add or modify the match resolution. Note: 'cet' is deprecated, use 'user_trees' instead.

status'pending' | 'accepted' | 'rejected' required

The match status of match resolution to add or modify.

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.

Response

The update was successful.