AFaffinity
Company Merges

Initiate Company Merge

Changed on

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

This is an asynchronous process that will merge all data from the duplicate company into the primary company. 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/company-merges

Request

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

Request body

primaryCompanyIdinteger required

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

duplicateCompanyIdinteger required

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

Example request

{
  "primaryCompanyId": 12345,
  "duplicateCompanyId": 67890
}

Response

Accepted

taskUrlstring uri required

URL to check the status of the merge task

Example response

{
  "taskUrl": "https://api.affinit.com/tasks/company-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