FAfamilysearch
Notes

Update Child and Parents Relationship Note

Update a specific child-and-parents relationship note.

post/tree/child-and-parents-relationships/{caprid}/notes/{nid}

Request

  • Base URL
    https://apibeta.familysearch.org/platform
  • URL
    https://apibeta.familysearch.org/platform/tree/child-and-parents-relationships/{caprid}/notes/{nid}
  • Auth
    HTTP bearer

Path parameters

capridstring required

The ID of the child-and-parents relationship. To find child-and-parents relationship IDs, see <a href="/reference/readpersonfamilies" target="_blank">Read Families</a>.

nidstring required

The ID of the note. To find note IDs, see <a href="/reference/readchildandparentsrelationshipnotes" target="_blank">Read Child and Parents Relationship Notes</a>.

Headers

Content-Type'application/x-fs-v1+json' | 'application/x-fs-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

{
  "childAndParentsRelationships": [
    {
      "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.