Update Person Note

post

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

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

pid

string

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

nid

string

required

The id of the note to be updated. To find note IDs, see Read Person Notes.

Body Params

The note to be used for the update.

persons

array of objects

required

length between 1 and 1

Array containing the person with the note to update. Exactly one person must be provided. See Person Schema (JSON)

persons*

notes

array of objects

required

length between 1 and 1

Array containing the note to update. Exactly one note must be provided. See Note Schema (JSON)

notes*

subject

string

required

The subject of the note

text

string

The text of the note

attribution

object

Attribution information for the note

Headers

X-Reason

string

The reason for updating the note.

Responses

204

The update was successful.

404

The requested note was not found.

410

The requested person has been merged or deleted.

429

The request was throttled.

Language

Credentials

Bearer

Loading…

Response

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