GuidesAPI ReferenceChangelogHelp
API Reference

Create Couple Relationship Note

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

Create a note attached to a couple relationship. The Couple Relationship Notes resource is an embedded resource, and any links to this resource are to be treated as embedded links.

Path Params
string
required

The id of the couple relationship the note is for. To find couple relationship IDs, see Read Families.

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

Array containing exactly one relationship with notes to add

relationships*
attribution
object
notes
array of objects
required
length ≥ 1

Array of notes to add to the relationship

notes*
string
required

The subject of the note

string
required

The text of the note

Headers
string
enum
required

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

Allowed:
string

The reason for creating the note.

Responses
201

The creation of the note was successful. Expect a location header specifying the link to the note.

400

If the request was unable to be understood by the application.

429

The request was throttled.

Updated 5 months ago

Language
Credentials
Bearer
Response 
Click Try It! to start a request and see the response here!
Updated 5 months ago