GuidesAPI ReferenceChangelogHelp
API Reference

Set Couple Relationship Spouses Order

post
https://apibeta.familysearch.org/platform/tree/couple-relationships//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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The ID of the couple relationship whose spouse ordering is to be set. To find couple relationship IDs, see Read Families.

Body Params
relationships
array of objects
required
length between 1 and 1

Array containing exactly one couple relationship with the desired spouse ordering. See Relationship Schema (JSON)

relationships*
string
required

The relationship type. Must be "http://gedcomx.org/Couple".

person1
object
required

The first spouse (will become person1 in the relationship). See ResourceReference Schema (JSON)

person2
object
required

The second spouse (will become person2 in the relationship). See ResourceReference Schema (JSON)

Headers
string

The reason for the spouse ordering.

Responses
204

The setting of spouse order was successful.

400

The id is invalid, the given spouses are not currently in the relationship, or the persons are currently in traditional order.

403

The relationship is restricted.

404

The requested relationship is not found.

410

The requested relationship has been deleted or merged.

429

The request was throttled.

Updated 9 days ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here!

Updated 9 days ago