Merge two constituents manually

POST

/api/constituents/merge

curl --request POST \
  --url https://example.com/api/constituents/merge \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "sourceConstituentId": "40000000-0000-0000-0000-000000000009", "targetConstituentId": "40000000-0000-0000-0000-000000000004", "mergeHouseholds": false, "fieldOverrides": { "firstName": "Sarah", "lastName": "Jenkins", "phone": "+17045550199", "email": "[email protected]", "addressStreet": "456 Oak Avenue", "addressCity": "Concord", "addressState": "NC", "addressZip": "28025", "dateOfBirth": "1988-04-15" } }'

Authorizations

• BearerAuth

Request Body^required

Media typeapplication/json

object

sourceConstituentId

required

UUID (v4) of source constituent record to merge into target.

string format: uuid

Example

40000000-0000-0000-0000-000000000009

targetConstituentId

required

UUID (v4) of target constituent record for merge operations.

string format: uuid

Example

40000000-0000-0000-0000-000000000004

mergeHouseholds

Flag indicating whether source and target households should be merged.

boolean

Example

false

fieldOverrides

object

firstName

First or given name.

string

Example

Sarah

lastName

Last or family name.

string

Example

Jenkins

phone

E.164 formatted contact phone number.

string

nullable

Example

+17045550199

email

Primary email address.

string

nullable

Example

[email protected]

addressStreet

Physical street address line.

string

nullable

Example

456 Oak Avenue

addressCity

City or municipality name.

string

nullable

Example

Concord

addressState

Two-letter US state abbreviation.

string

nullable

Example

NC

addressZip

5-digit US ZIP postal code.

string

nullable

Example

28025

dateOfBirth

Date of birth formatted as YYYY-MM-DD.

string format: date

nullable

Example

1988-04-15

Responses

200

Constituents merged successfully

400

Bad request

401

Unauthorized

403

Forbidden

404

Constituent not found