FAfamilysearch
Notes

Update Couple Relationship Note

Update a couple relationship note.

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

Request

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

Path parameters

cridstring required

The id of the couple relationship whose note is to be updated. To find couple relationship IDs, see <a href="/reference/readpersonfamilies" target="_blank">Read Families</a>.

nidstring required

The id of the note to be updated. To find note IDs, see <a href="/reference/getcouplerelationshipnotes" target="_blank">Read Couple Relationship Notes</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 updating the note.

Request body

Example request

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

Response

The update was successful.

Changes

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