Contact Record Matching

"match_by" options for the "contact" import format

When you want to create a new record via the import API, the following are your options for preventing duplicates.

In the contact format, if not otherwise specified, the external_id is the default "match by" option.

match_by Option
Description

external_id

This is the default.

Use your (3rd party) identifier for the contact record (external to Kindful). Requires that the external_id field is populated upon import.

The provided external_id will be converted to a string before locating a match.

use the contacts id field for matching.

id

Will match the request record's id field to Kindful's contact id. Please note that if contact records have been merged in Kindful, it's possible that the final id that is matched could be different than what was specified in the request.

use the contacts id field for matching

first_name_last_name

NOT RECOMMENDED
Will search for records with an exact match of first and last name. This search is not case sensitive. (This method should only be used for small organizations that don't have duplicate names)

use the contacts first_name and last_name fields for matching

first_name_last_name_email

Will search for records with an exact match of first name, last name, and email address. This search is not case sensitive.

use the contacts first_name, last_name, and email fields for matching

email

Will search for records with an exact match of email address. This search is not case sensitive.

use the contacts email field for matching

company_name

NOT RECOMMENDED
Will search for records that match the company name of a contact record. This search is not case sensitive.

company_name_email

Will search for records that match the company name and email of a contact record. This search is not case sensitive.

stripe_customer_id (coming soon)

Will search for records with a matching stripe customer id.

use the contacts id field for matching

stripe_charge_id (coming soon)

Will search for transactions with a matching stripe_charge_id and step up to the associated contact.

use the contacts id field for matching

paypal_transaction_id (coming soon)

Will search for matching transaction_id from PayPal and finding the associated contact.

use the contacts id field for matching

authorize_customer_id (coming soon)

Will search for matching Authorize customer id.

use the contacts id field for matching

More Info

For more information about Record Matching, please Intro to Record Matching


Contact Record Matching

"match_by" options for the "contact" import format