FAfamilysearch
Persons

Update Person

Update a single Person by the person ID including the names, gender, and facts of the person.

Conclusions in the body with a conclusion ID are assumed to be updates; otherwise, they are creates.

The response will contain the person payload passed in with conclusion IDs added for new conclusions.

post/tree/persons/{pid}

Request

  • Base URL
    https://apibeta.familysearch.org/platform
  • URL
    https://apibeta.familysearch.org/platform/tree/persons/{pid}
  • Auth
    HTTP bearer

Path parameters

pidstring required

The id of the person to update. 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 request body.

Accept'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 response body.

X-Reasonstring

The reason for updating the person.

Request body

Example request

{
  "persons": [
    {
      "gender": {
        "type": "http://gedcomx.org/Male"
      },
      "names": [
        {
          "type": "http://gedcomx.org/BirthName",
          "preferred": true,
          "nameForms": [
            {
              "fullText": "John Smith",
              "parts": [
                {
                  "type": "http://gedcomx.org/Given",
                  "value": "John"
                }
              ]
            }
          ],
          "attribution": {
            "changeMessage": "message"
          }
        }
      ],
      "facts": [
        {
          "type": "http://gedcomx.org/Birth",
          "date": {
            "original": "3 Apr 1836",
            "formal": "+1836"
          },
          "place": {
            "original": "Moscow, Russia",
            "normalized": "Moscow, Moskva, Russia"
          },
          "attribution": {
            "changeMessage": "message"
          }
        }
      ]
    }
  ]
}

Response

The read was successful. Expect conclusion ids to be returned in the response body.

Changes

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