FAfamilysearch
Persons

Update Tree Person Published State

Publish or unpublish a person. Send published=false to unpublish the person or published=true to publish it again. An optional reason for the change may be sent in the 'X-Reason' header. There is no request body. Read the person to see the current state, reported as the published attribute of its PersonInfo.

post/tree/persons/{pid}/published

Request

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

Path parameters

pidstring required

The id of the person. 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>.

Query parameters

publishedboolean required

true publishes the person; false unpublishes the person.

Headers

X-Reasonstring

The reason for publishing or unpublishing the person.

Response

The update was successful.

Changes

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