AFaffinity
Person Merges

Initiate Person Merge

Changed on

Initiate a person merge to combine a duplicate person profile into a primary person profile.

This is an asynchronous process that will merge all data from the duplicate person into the primary person. Once the merge is initiated, you can track its progress using the returned task URL.

Requires the "Manage duplicates" permission and organization admin role.

post/v2/person-merges

Request

  • Base URL
    https://api.affinity.co
  • URL
    https://api.affinity.co/v2/person-merges
  • Auth
    HTTP bearer

Request body

primaryPersonIdinteger required

The ID of the person profile that will be kept after the merge. All data from the duplicate person will be merged into this person.

duplicatePersonIdinteger required

The ID of the person profile that will be merged and then deleted. All data from this person will be transferred to the primary person.

Example request

{
  "primaryPersonId": 12345,
  "duplicatePersonId": 67890
}

Response

Accepted

taskUrlstring uri required

URL to check the status of the merge task

Example response

{
  "taskUrl": "https://api.affinit.com/tasks/person-merges/123e4567-e89b-12d3-a456-426614174000"
}

Changes

  • 187749f77548Revision changes
    • info

      added authentication authorization bad-request conflict method-not-allowed not-acceptable not-found not-implemented rate-limit server timeout unprocessable-entity unsupported-media-type validation discriminator mapping keys to the / response property for the response status

    • info

      added bad-request validation discriminator mapping keys to the / response property for the response status