Skip to content

Latest commit

 

History

History
9 lines (6 loc) · 61.4 KB

File metadata and controls

9 lines (6 loc) · 61.4 KB

MergeContactsRequest

Fields

Field Type Required Description Example
id String ✔️ ID of a contact. 04ca6ae2-0dc3-487b-953e-86d6abbdf7d3
contactMerge ContactMerge ✔️ Merge the 'main' contact with one or two other 'secondary' contacts. By default, the main contact's values will be used for the merged contact if present. Otherwise, the secondary contact's value is used. For contact memberships and contact profile image, only the main contact's data is used.

When merging contacts that contain secure fields, the event/contacts:write-sensitive scope is required.

Conflict Resolution

* contactFields: A conflict arises for a contact field if it is empty in the main contact, two secondary contacts are provided, and both secondary contacts have values for the field.
- You must provide the fieldName of the conflicted field and the ID of the contact whose value is to be kept to continue with the merge.
- This array can also be used to override the default behavior and choose which contact to pull values from for each contact field.
- The following contact fields are supported:
- sourceId
- firstName
- lastName
- prefix
- email
- ccEmail
- company
- type.id
- nickname
- title
- workPhone
- middleName
- mobilePhone
- gender
- npi
- homeFax
- designation
- homePhone
- pager
- workFax
- lastModifiedBy
- lastModified
- created
- createdBy
- workAddress (for address fields, the full address of work or home are taken all together from a given contact)
- homeAddress
- deleted
- optOut.date
- _links.linkedInUrl
- _links.facebookUrl
- _links.twitterUrl
- customField.{uuid of custom field}
* events: A conflict arises for an event if it contains attendees associated with at least two of the provided contacts.
- You must provide the ID of the conflicted event and the ID of the contact whose attendee is to be associated with the merged contact to continue with the merge.
- Attendees with a 'No Response' or 'Visited' status whose linked contacts are not chosen in this step will be deleted. Attendees with other statuses will be kept but will be associated with an inactive contact.

* surveys: A conflict arises for a survey containing respondents associated with at least two of the provided contacts.
- You must provide the ID of the conflicted survey and the ID of the contact whose respondent will be associated with the merged contact to continue with the merge.
- Respondents with a 'No Response' or 'Visited' status whose linked contacts are not chosen in this step will be deleted. Respondents with other statuses will be kept but will be associated with an inactive contact.
- Only legacy surveys support merge functionality at this time.
* contactRelationships: By default, the main contact's relationships are carried over to the merged contact, and those of the other contact(s) are discarded. This is the default regardless of whether the main contact has relationships or not.
- You can provide a secondary contact's ID to carry over its relationships instead of the main contact. Only one contact's relationships can be carried over.