GuidesAPI ReferenceChangelogHelp
API Reference

Update Couple Relationship

post
https://apibeta.familysearch.org/platform/tree/couple-relationships/

Add or update specific facts attached to a couple. FamilySearch also allows you to update the persons in a couple relationship.

Path Params
string
required

The id of the couple relationship. To find couple relationship IDs, see Read Families.

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

Array containing exactly one relationship to update

relationships*
facts
array of objects
required
length ≥ 1

Array of facts to add or update on the relationship.

facts*
string

The ID of the fact to update. Omit this field to create a new fact. To find fact IDs, see Read Couple Relationship.

string
required

The type of fact (e.g., http://gedcomx.org/Marriage, http://gedcomx.org/Divorce)

date
object
place
object
attribution
object
Headers
string
enum
required

Specifies the media type(s) that the client is willing to accept in the response.

Allowed:
string
enum
required

Specifies the media type of the entity-body sent to the server in the request.

Allowed:
string

The reason for the couple relationship update.

Responses
201

The successful update contained a single conclusion. Expect the id of the conclusion in the 'Location' header.

204

The update was successful.

404

If the requested relationship is not found.

410

If the requested relationship has been deleted or merged.

429

The request was throttled.

Updated 5 months ago

Language
Credentials
Bearer
Response 
Click Try It! to start a request and see the response here!
Updated 5 months ago