v1

latestOpenAPI 3.0.1Apache 2.02026-07-2420454370.2 KB
Notes

Create Couple Relationship Note

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.

post/tree/couple-relationships/{crid}/notes

Path parameters

cridstring required

The id of the couple relationship the note is for. To find couple relationship IDs, see <a href="/reference/readpersonfamilies" target="_blank">Read Families</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 creating the note.

Response

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