FAfamilysearch
Portraits

Update Person Portraits

Update the portrait list associated with a tree person.

post/tree/persons/{pid}/portraits

Request

  • Base URL
    https://apibeta.familysearch.org/platform
  • URL
    https://apibeta.familysearch.org/platform/tree/persons/{pid}/portraits
  • Auth
    HTTP bearer

Path parameters

pidstring required

The id of the person whose portraits are being updated. Can be a person from the main FamilySearch tree or from a user tree. To find an example person ID, see <a href="/reference/searchtreepersons" target="_blank">Search Tree Persons</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.

Request body

Example request

{
  "person": {
    "media": [
      {
        "description": "https://api.familysearch.org/platform/memories/memories/3745023",
        "qualifiers": [
          {
            "name": "http://gedcomx.org/RectangleRegion",
            "value": "0.1,0.2,0.3,0.4"
          }
        ],
        "attribution": {
          "changeMessage": "message"
        }
      }
    ]
  }
}

Response

The update was successful.

Changes

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