Source Box

Update User Defined Collection

Update a user-defined collection. The Source Folder resource defines the interface for a source folder. This resource is used to update a source folder. The default source folder is the folder without a name. If a folder isn't specified when a source is attached, the source will be put in the default folder.

post/sources/collections/{udcid}

Request

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

Path parameters

udcidstring required

The id of the user-defined collection (source folder). To find user-defined collection IDs, see <a href="/reference/readusersourcefolders" target="_blank">Read User Source Folders</a>, or <a href="/reference/createsourcefolder" target="_blank">Create Source Folder</a> to create a new user-defined collection.

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

{
  "collections": [
    {
      "title": "My Research Sources",
      "attribution": {
        "changeMessage": "Updated folder name"
      }
    }
  ]
}

Response

The update was successful.

Changes

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