GuidesAPI ReferenceChangelogHelp
API Reference

Update Couple Relationship Note

post
https://apibeta.familysearch.org/platform/tree/couple-relationships//notes/

Update a couple relationship note.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The id of the couple relationship whose note is to be updated. To find couple relationship IDs, see Read Families.

string
required

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

Body Params
relationships
array of objects
required
length between 1 and 1

Array containing exactly one relationship with the note to update. See Relationship Schema (JSON)

relationships*
attribution
object
notes
array of objects
required
length between 1 and 1

Array containing exactly one note to update. See Note Schema (JSON)

notes*
string
required

The subject of the note

string
required

The text of the note

Headers
string

The reason for updating the note.

Responses
204

The update was successful.

404

If the requested note is not found.

429

The request was throttled.

Updated 2 months ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here!

Updated 2 months ago

Did this page help you?