Merges

Merges Documentation

Merge [POST]

Merge [POST]

Request

Endpoint

POST /api/v2/contacts/433afbbe-2024-41f9-b626-de0c9bc36756/people/merges
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "merges",
    "attributes": {
    },
    "relationships": {
      "loser": {
        "data": {
          "type": "people",
          "id": "76adb445-40a5-4ae7-8b24-99e853e85769"
        }
      },
      "winner": {
        "data": {
          "type": "people",
          "id": "f35332de-9515-41d1-8961-18ef7af884bb"
        }
      }
    }
  }
}

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": "f35332de-9515-41d1-8961-18ef7af884bb",
    "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": "2022-01-12T17:18:30Z",
      "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": [
        "433afbbe-2024-41f9-b626-de0c9bc36756"
      ],
      "suffix": null,
      "title": null,
      "updated_at": "2022-01-12T17:18:30Z",
      "updated_in_db_at": "2022-01-12T17:18:30Z"
    },
    "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": "b70128ce-d175-4349-a228-deb4dcc2aab1",
          "loser_id": "84cdd653-df55-4e16-8d62-39d79a0b375d"
        }
      }
    }
  ]
}

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

[
  {
    "data": {
      "id": "b70128ce-d175-4349-a228-deb4dcc2aab1",
      "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": "2022-01-12T17:18:05Z",
        "deceased": false,
        "employer": null,
        "first_name": "Gina",
        "gender": null,
        "last_name": "Greenfelder",
        "legal_first_name": null,
        "marital_status": null,
        "middle_name": null,
        "occupation": null,
        "optout_enewsletter": false,
        "parent_contacts": [
          "072f35ac-3f8a-4193-a271-73b2d382b004"
        ],
        "suffix": null,
        "title": null,
        "updated_at": "2022-01-12T17:18:05Z",
        "updated_in_db_at": "2022-01-12T17:18:05Z"
      },
      "relationships": {
        "email_addresses": {
          "data": [

          ]
        },
        "facebook_accounts": {
          "data": [

          ]
        },
        "family_relationships": {
          "data": [

          ]
        },
        "linkedin_accounts": {
          "data": [

          ]
        },
        "phone_numbers": {
          "data": [

          ]
        },
        "twitter_accounts": {
          "data": [

          ]
        },
        "websites": {
          "data": [

          ]
        }
      }
    }
  }
]