Update Match Resolution

post

https://apibeta.familysearch.org/platform/tree/persons/{pid}/matches

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.

Path Params

pid

string

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 Search Tree Persons.

Query Params

collection

string

enum

Defaults to records

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

Allowed:

status

string

enum

required

The match status of match resolution to add or modify.

Allowed:

Body Params

Gedcomx object containing the match resolution

persons

array of objects

required

length between 1 and 1

Array containing exactly one person with the match resolution details

persons*

attribution

object

required

Attribution information for the match resolution

identifiers

object

required

Identifiers for the record persona

Headers

Content-Type

string

enum

required

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

Allowed:

Responses

204

The update was successful.

301

If the referenced person has been merged into another person.

404

If the referenced person is not found.

410

If the referenced person has been deleted.

429

The request was throttled.

Language

Credentials

Bearer

Response

Click Try It! to start a request and see the response here!