Sources

Update Source Description

Update a Source Description.

The Source Description resource updates a user's source description. The FamilySearch implementation of the Source Description resource does not support all properties of a source description as defined by GEDCOM X. Support is limited to the following:

Property	Description
id	A local identifier for the source description.
about	URI to the resource being described, if any.
title	Label, title, or other name to display to the user for the source.
citation	The citation for the source. FamilySearch only supports the value of the citation and not any template or associated citation fields.
notes	Notes about the source provided by a user.

post/sources/descriptions/{sdid}

Request

Base URL
https://apibeta.familysearch.org/platform
URL
https://apibeta.familysearch.org/platform/sources/descriptions/{sdid}
Auth
HTTP bearer

Path parameters

sdidstring required

The id of the source description to update. To find source description IDs, see <a href="/reference/readusersourcedescriptions" target="_blank">Read User Source Descriptions</a>, or <a href="/reference/createsourcedescription" target="_blank">Create Source Description</a> to create a new source description.

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.

Request body

Example request

{
  "sourceDescriptions": [
    {
      "about": "https://familysearch.org/pal:/MM9.1.1/M9PJ-2JJ",
      "citations": [
        {
          "value": "\"United States Census, 1900.\" database and digital images, FamilySearch"
        }
      ],
      "titles": [
        {
          "value": "1900 US Census, Ethel Hollivet"
        }
      ],
      "notes": [
        {
          "text": "Additional context about this source"
        }
      ],
      "attribution": {
        "changeMessage": "Updated source information"
      }
    }
  ]
}

Response

The update was successful.

Changes

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