Merges
Merges Documentation
Merge [POST]
Merge [POST]
Request
Endpoint
POST /api/v2/contacts/5b33ae5a-4b1e-4b77-8b3a-38c2b575ac81/people/merges
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "merges",
"attributes": {
},
"relationships": {
"loser": {
"data": {
"type": "people",
"id": "8e2ed6cc-b309-496f-9648-0adb5006a75d"
}
},
"winner": {
"data": {
"type": "people",
"id": "d5a40aa6-23bc-408f-8970-0ee98d405f96"
}
}
}
}
}
Parameters
Relationships
loser.data
Type
Contact
Description person to merge
Required No
winner.data
Type
Contact
Description person to keep
Required No
Response
Headers
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
Body
{
"data": {
"id": "d5a40aa6-23bc-408f-8970-0ee98d405f96",
"type": "people",
"attributes": {
"alma_mater": null,
"anniversary_day": null,
"anniversary_month": null,
"anniversary_year": null,
"avatar": "https://mpdx.org/images/avatar.png",
"birthday_day": null,
"birthday_month": null,
"birthday_year": null,
"created_at": "2021-11-23T14:38:21Z",
"deceased": false,
"employer": null,
"first_name": "John",
"gender": null,
"last_name": "Doe",
"legal_first_name": null,
"marital_status": null,
"middle_name": null,
"occupation": null,
"optout_enewsletter": false,
"parent_contacts": [
"5b33ae5a-4b1e-4b77-8b3a-38c2b575ac81"
],
"suffix": null,
"title": null,
"updated_at": "2021-11-23T14:38:21Z",
"updated_in_db_at": "2021-11-23T14:38:21Z"
},
"relationships": {
"email_addresses": {
"data": [
]
},
"facebook_accounts": {
"data": [
]
},
"family_relationships": {
"data": [
]
},
"linkedin_accounts": {
"data": [
]
},
"phone_numbers": {
"data": [
]
},
"twitter_accounts": {
"data": [
]
},
"websites": {
"data": [
]
}
}
}
}
Fields
Attributes
alma_mater
Type
string
Description The college a person graduated from
anniversary_day
Type
number
Description Anniversary Day
anniversary_month
Type
number
Description Anniversary Month
anniversary_year
Type
number
Description Anniversary Year
avatar
Type
string
Description Avatar
birthday_day
Type
number
Description Birthday Day
birthday_month
Type
number
Description Birthday Month
birthday_year
Type
number
Description Birthday Year
created_at
Type
date
Description The timestamp of when this resource was created
deceased
Type
boolean
Description Deceased
employer
Type
string
Description Employer
first_name
Type
string
Description First Name
gender
Type
string
Description Gender
last_name
Type
string
Description Last Name
legal_first_name
Type
string
Description Legal First Name
marital_status
Type
string
Description Marital Status
middle_name
Type
string
Description Middle Name
occupation
Type
string
Description Occupation
optout_enewsletter
Type
boolean
Description Optout of enewsletter
parent_contacts
Type
[Contact]
Description Parent contacts of this person
suffix
Type
string
Description Suffix
title
Type
string
Description Title
updated_at
Type
date
Description The timestamp of when this resource was last updated
updated_in_db_at
Type
date
Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.
Relationships
email_addresses.data
Type
[Email Address]
Description Array of email_addresses
facebook_accounts.data
Type
[Facebook Account]
Description Array of facebook_accounts
family_relationships.data
Type
[Family Relationship]
Description Array of family relationships
linkedin_accounts.data
Type
[Linkedin Account]
Description Array of linkedin accounts
phone_numbers.data
Type
[Phone Number]
Description Array of phone numbers
twitter_accounts.data
Type
[Twitter Account]
Description Array of twitter accounts
websites.data
Type
[Website]
Description Array of websites
Merges [BULK POST]
Bulk merge People with the given IDs
Request
Endpoint
POST /api/v2/contacts/people/merges/bulk
Content-Type: application/vnd.api+json
Body
{
"data": [
{
"data": {
"attributes": {
"winner_id": "e8005f81-8785-48ab-90e5-e82999e1bf1f",
"loser_id": "48c508c5-ac10-43a1-b92e-aff030efb4ad"
}
}
}
]
}
Response
Headers
Content-Type: application/vnd.api+json; charset=utf-8
200 OK
Body
[
{
"data": {
"id": "e8005f81-8785-48ab-90e5-e82999e1bf1f",
"type": "people",
"attributes": {
"alma_mater": null,
"anniversary_day": null,
"anniversary_month": null,
"anniversary_year": null,
"avatar": "https://mpdx.org/images/avatar.png",
"birthday_day": null,
"birthday_month": null,
"birthday_year": null,
"created_at": "2021-11-23T14:38:31Z",
"deceased": false,
"employer": null,
"first_name": "Joni",
"gender": null,
"last_name": "Cassin",
"legal_first_name": null,
"marital_status": null,
"middle_name": null,
"occupation": null,
"optout_enewsletter": false,
"parent_contacts": [
"047ab635-d4ae-4fef-81ac-43e19dda5107"
],
"suffix": null,
"title": null,
"updated_at": "2021-11-23T14:38:31Z",
"updated_in_db_at": "2021-11-23T14:38:31Z"
},
"relationships": {
"email_addresses": {
"data": [
]
},
"facebook_accounts": {
"data": [
]
},
"family_relationships": {
"data": [
]
},
"linkedin_accounts": {
"data": [
]
},
"phone_numbers": {
"data": [
]
},
"twitter_accounts": {
"data": [
]
},
"websites": {
"data": [
]
}
}
}
}
]
Last updated