Merge two contacts

Merges one contact into another and deletes the contact that was merged. The destination contact survives and keeps its id; the source contact's lists, tags, automations, deals, notes and activity are moved onto the destination, and the source is then removed.

The merge runs synchronously, so the response means the contacts have already been merged. It cannot be undone.

Where the two contacts hold conflicting information, resolutionFieldId and resolutionAutomationId name which of the two contacts wins: field values are taken from the contact named by resolutionFieldId, and automation membership from the contact named by resolutionAutomationId.

Requires the pg_subscriber_merge permission.

Body Params
int32
required

Id of the contact to merge in. This contact is deleted once the merge completes.

int32
required

Id of the contact that survives the merge.

int32

Id of the contact whose field values win where both contacts hold a value. Must be the source or the destination.

int32

Id of the contact whose automation membership wins where both contacts are in the same automation. Must be the source or the destination.

Responses

403

The caller lacks the pg_subscriber_merge permission.

422

source is missing, or source and destination are the same contact.

Language
Credentials
Header
URL
LoadingLoading…
Response
Choose an example:
application/json