FAfamilysearch
Notes

Update Person Note

Update a note attached to a person. The Person Note resource is an embedded resource, and any links to this resource are to be treated as embedded links.

post/tree/persons/{pid}/notes/{nid}

Request

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

Path parameters

pidstring required

The id of the person whose note is to be updated. 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>.

nidstring required

The id of the note to be updated. To find note IDs, see <a href="/reference/readpersonnotes" target="_blank">Read Person Notes</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 reason for updating the note.

Request body

Example request

{
  "persons": [
    {
      "notes": [
        {
          "subject": "Sample",
          "text": "Sample note text",
          "attribution": {
            "changeMessage": "message"
          }
        }
      ]
    }
  ]
}

Response

The update was successful.

Changes

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