Relationships: Couple

Set Couple Relationship Spouses Order

Set the ordering of spouse1 and spouse2 in a relationship by explicitly designating which existing spouse should be person1 and which should be person2.

post/tree/couple-relationships/{crid}/spouses/order

Request

Base URL
https://apibeta.familysearch.org/platform
URL
https://apibeta.familysearch.org/platform/tree/couple-relationships/{crid}/spouses/order
Auth
HTTP bearer

Path parameters

cridstring required

The ID of the couple relationship whose spouse ordering is to be set. To find couple relationship IDs, see <a href="/reference/readpersonfamilies" target="_blank">Read Families</a>.

Headers

X-Reasonstring

The reason for the spouse ordering.

Request body

Example request

{
  "relationships": [
    {
      "type": "http://gedcomx.org/Couple"
    }
  ]
}

Response

The setting of spouse order was successful.

Changes

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