v1

latestOpenAPI 3.0.1Apache 2.02026-07-2420454370.2 KB
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:

PropertyDescription
idA local identifier for the source description.
aboutURI to the resource being described, if any.
titleLabel, title, or other name to display to the user for the source.
citationThe citation for the source. FamilySearch only supports the value of the citation and not any template or associated citation fields.
notesNotes about the source provided by a user.
post/sources/descriptions/{sdid}

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.

Response

The update was successful.