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

Request

Base URL
https://apibeta.familysearch.org/platform
URL
https://apibeta.familysearch.org/platform/tree/couple-relationships/{crid}/notes
Auth
HTTP bearer

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.

Request body

Example request

{
  "relationships": [
    {
      "attribution": {
        "changeMessage": "Message"
      },
      "notes": [
        {
          "subject": "Sample",
          "text": "Sample note text"
        }
      ]
    }
  ]
}

Response

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

Changes

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