v1

latestOpenAPI 3.0.1Apache 2.02026-07-2420454370.2 KB
Relationships: Couple

Delete Preferred Spouse Relationship

Delete the preferred spouse relationship for the given user and tree person. The preferred spouse relationship affects only the user that creates it.

delete/tree/users/{uid}/preferred-spouse-relationships/{pid}

Path parameters

uidstring required

The id of the authenticated user. To find user IDs, see <a href="/reference/readcurrentuser" target="_blank">Read Current User</a>.

pidstring required

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

Response

The delete was successful.