Contact Duplicates

Contact Duplicates

Gets all of the contact duplicates in the system.

This method will scan all contact duplicates and and return them to the caller.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

query Parameters
fields
string

The fields that you want to retrieve; if omitted, the entire object is returned.

exclusiveStartKey
string

The start key, if you're making a subsequent request

Responses
200The contact duplicateswere retrieved successfully.
400The request was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
429Limit exceeded... unable to add contact role based on tenant limits.
500General server error.
get/contactDuplicates/{tenantId}
Request samples
curl -i -X GET \
  'https://rolodex.api.756794052567.rhythmsoftware.com/contactDuplicates/:tenantId?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Search for potential duplicates

This method searches for potential duplicates

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed

Request Body schema: application/json

The data you would like to try to check for duplicates

email_address
string (Email Address)

The primary email address

email_address2
string (Email Address2)

Secondary email address

email_address3
string (Email Address3)

Tertiary email address

first_name
string (First Name)

The contact's first name

last_name
string (Last Name)

The contact's last name

home_address_postal_code
string (Home Address Postal Code)

The home address postal code of the contact

work_address_postal_code
string (Work Address Postal Code)

The work address postal code of the contact

alt_address_postal_code
string (Alt Address Postal Code)

An alternative address postal code of the contact

minimum_confidence
number <float> (Minimum Confidence)

The minimum degree of confidence on a scale of 1 to 100 that you would like considered a potential duplicate

Responses
200Potential duplicates were retrieved successfully
400The search you supplied was invalid.
401Unauthorized
403Forbidden
404The resource could not be found
429Limit exceeded... unable to add order based on tenant limits.
500General server error
post/contactDuplicates/{tenantId}
Request samples
    1 more
    Python
application/json
{
  • "email_address": "string",
  • "email_address2": "string",
  • "email_address3": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "home_address_postal_code": "string",
  • "work_address_postal_code": "string",
  • "alt_address_postal_code": "string",
  • "minimum_confidence": 0
}
Response samples
application/json
[
  • {
    }
]

Returns a contact duplicate from the system by its ID.

This method will look up a contact duplicate by the specified ID and return it back.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the contact duplicate to return.

query Parameters
fields
string

The fields that you want to retrieve; if omitted, the entire object is returned.

consistentRead
string

Indicates the API should force a consistent read on the data source.

Responses
200The contact duplicate was retrieved successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The contact duplicate could not be found.
429Limit exceeded... unable to retrieve contact duplicate based on tenant limits.
500General server error.
get/contactDuplicates/{tenantId}/{id}
Request samples
curl -i -X GET \
  'https://rolodex.api.756794052567.rhythmsoftware.com/contactDuplicates/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "email_address": "string",
  • "email_address2": "string",
  • "email_address3": "string",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "first_name_metaphones": [
    ],
  • "first_name_primary_metaphone": "string",
  • "first_name_secondary_metaphone": "string",
  • "last_name_metaphones": [
    ],
  • "last_name_primary_metaphone": "string",
  • "last_name_secondary_metaphone": "string",
  • "postal_codes": [
    ],
  • "home_address_postal_code": "string",
  • "work_address_postal_code": "string",
  • "alt_address_postal_code": "string",
  • "organization_id": "string",
  • "preferred_address": {
    },
  • "phone_numbers": [
    ],
  • "mobile_phone_number": "string",
  • "work_mobile_phone_number": "string",
  • "home_phone_number": "string",
  • "work_phone_number": "string",
  • "school_phone_number": "string",
  • "other_phone_numbers": [
    ],
  • "possible_duplicates": [
    ],
  • "number_of_possible_duplicates": 0,
  • "highest_confidence": 0,
  • "whitelist": [
    ],
  • "manual_duplicates": [
    ],
  • "sys_match_directive": "string",
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Updates a contact duplicate with the specified ID.

This method will update an existing contact duplicate with the specified ID.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the contact duplicate to update.

Request Body schema: application/json

The updated contact duplicate that will be saved.

id
required
string (ID) /^[\w|-]+$/

The unique, string identifier of this contact

email_address
string (Email Address)

The primary email address

email_address2
string (Email Address2)

Secondary email address

email_address3
string (Email Address3)

Tertiary email address

first_name
string (First Name)

The contact's first name

middle_name
string (Middle Name)

The contact's middle name

last_name
string (Last Name)

The contact's last name

first_name_metaphones
Array of strings (First Name Metaphones)

The metaphones calculated from the contact's first name

first_name_primary_metaphone
string (First Name Primary Metaphone)

The primary metaphone calculated from the contact's first name

first_name_secondary_metaphone
string (First Name Secondary Metaphone)

The secondary metaphone calculated from the contact's first name

last_name_metaphones
Array of strings (Last Name Metaphones)

The metaphones calculated from the contact's last name

last_name_primary_metaphone
string (Last Name Primary Metaphone)

The primary metaphone calculated from the contact's last name

last_name_secondary_metaphone
string (Last Name Secondary Metaphone)

The secondary metaphone calculated from the contact's last name

postal_codes
Array of strings (Postal Codes)

The postal codes off all the contact's addresses

home_address_postal_code
string (Home Address Postal Code)

The home address postal code of the contact

work_address_postal_code
string (Work Address Postal Code)

The work address postal code of the contact

alt_address_postal_code
string (Alt Address Postal Code)

An alternative address postal code of the contact

organization_id
string (Organization)

The ID of the organization that the contact belongs to

object (Address)

A complete address

phone_numbers
Array of strings (Phone Numbers)

All of the contact's phone numbers

mobile_phone_number
string (Mobile Phone Number)

Mobile phone number

work_mobile_phone_number
string (Work Mobile Phone Number)

Mobile phone number for business unit

home_phone_number
string (Home Phone Number)

Home phone number

work_phone_number
string (Work Phone Number)

Work phone number

school_phone_number
string (School Phone Number)

Fax phone number

Array of objects
Array of objects

The contacts that are potentially duplicates of this contact

number_of_possible_duplicates
number <float> (Number Of Possible Duplicates)

The number of possible duplicates excluding whitelisted records

highest_confidence
number <float> (Highest Confidence)

The highest confidence score within the possible duplicates excluding whitelisted records

whitelist
Array of strings (Whitelist)

The IDs of contacts that have been manually identified as not duplicates of this contact. These IDs may appear in the possible_duplicates array but should not be presented

manual_duplicates
Array of strings (Manual Duplicates)

The IDs of contacts that have been manually identified as duplicates of this contact

sys_match_directive
string (Sys Match Directive)
sys_deleted_by_id
string (Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_version
number <float> (Sys Version)

A number representing the version of this record in the database

sys_created_at
required
string <date-time> (Sys Created At)

The date/time that this record was created, expressed in ISO-8601 date format

sys_last_modified_at
required
string <date-time> (Sys Last Modified At)

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_created_by_id
required
string (Sys Created By)

The ID of the user that created this record

sys_last_modified_by_id
required
string (Sys Last Modified By)

The ID of the user that last modified this record

sys_external_id
string (Sys External)

The ID that a record has from an external system or data import

sys_locked
boolean (Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_bulk_load_pk
string (Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_at
string (Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_id
string (Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_record_no
number <float> (Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_file
string (Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_last_bulk_data_operation_id
string (Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_version
string (Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

sys_calculated_field_error
string (Sys Calculated Field Error)

The error associated with the calculated field

sys_snapshot_base_version
number <float> (Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_has_files_in_s3
boolean (Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_configuration_snapshot_id
string (Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_last_security_context
object (Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

Array of objects
Responses
200The contact duplicate was updated successfully.
400The contact duplicate supplied was not valid.
401Unauthorized.
403Forbidden.
404The contact duplicate could not be found.
409The contact duplicate could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve contact duplicate based on tenant limits.
500General server error.
put/contactDuplicates/{tenantId}/{id}
Request samples
    1 more
    Python
application/json
{
  • "id": "string",
  • "email_address": "string",
  • "email_address2": "string",
  • "email_address3": "string",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "first_name_metaphones": [
    ],
  • "first_name_primary_metaphone": "string",
  • "first_name_secondary_metaphone": "string",
  • "last_name_metaphones": [
    ],
  • "last_name_primary_metaphone": "string",
  • "last_name_secondary_metaphone": "string",
  • "postal_codes": [
    ],
  • "home_address_postal_code": "string",
  • "work_address_postal_code": "string",
  • "alt_address_postal_code": "string",
  • "organization_id": "string",
  • "preferred_address": {
    },
  • "phone_numbers": [
    ],
  • "mobile_phone_number": "string",
  • "work_mobile_phone_number": "string",
  • "home_phone_number": "string",
  • "work_phone_number": "string",
  • "school_phone_number": "string",
  • "other_phone_numbers": [
    ],
  • "possible_duplicates": [
    ],
  • "number_of_possible_duplicates": 0,
  • "highest_confidence": 0,
  • "whitelist": [
    ],
  • "manual_duplicates": [
    ],
  • "sys_match_directive": "string",
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}
Response samples
application/json
{
  • "id": "string",
  • "email_address": "string",
  • "email_address2": "string",
  • "email_address3": "string",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "first_name_metaphones": [
    ],
  • "first_name_primary_metaphone": "string",
  • "first_name_secondary_metaphone": "string",
  • "last_name_metaphones": [
    ],
  • "last_name_primary_metaphone": "string",
  • "last_name_secondary_metaphone": "string",
  • "postal_codes": [
    ],
  • "home_address_postal_code": "string",
  • "work_address_postal_code": "string",
  • "alt_address_postal_code": "string",
  • "organization_id": "string",
  • "preferred_address": {
    },
  • "phone_numbers": [
    ],
  • "mobile_phone_number": "string",
  • "work_mobile_phone_number": "string",
  • "home_phone_number": "string",
  • "work_phone_number": "string",
  • "school_phone_number": "string",
  • "other_phone_numbers": [
    ],
  • "possible_duplicates": [
    ],
  • "number_of_possible_duplicates": 0,
  • "highest_confidence": 0,
  • "whitelist": [
    ],
  • "manual_duplicates": [
    ],
  • "sys_match_directive": "string",
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Partially updates a contact duplicate with the specified ID.

This method will patch an existing contact duplicate with the specified ID, using the HTTP PATCH specification.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the contact duplicate to patch.

Request Body schema: application/json

The patch directives conforming to RFC 6902.

Array
op
required
string (Op)

The operation

Enum: "add" "remove" "replace" "move" "copy" "test"
path
required
string (Path)

The JSON path

value
string (Value)

The updated value

Responses
200The contact duplicate was patched successfully.
400The JSON patch directive you supplied was not valid.
401Unauthorized.
403Forbidden.
404The contact duplicate could not be found.
409The contact duplicate could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve contact duplicate based on tenant limits.
500General server error.
patch/contactDuplicates/{tenantId}/{id}
Request samples
    1 more
    Python
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "string",
  • "email_address": "string",
  • "email_address2": "string",
  • "email_address3": "string",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "first_name_metaphones": [
    ],
  • "first_name_primary_metaphone": "string",
  • "first_name_secondary_metaphone": "string",
  • "last_name_metaphones": [
    ],
  • "last_name_primary_metaphone": "string",
  • "last_name_secondary_metaphone": "string",
  • "postal_codes": [
    ],
  • "home_address_postal_code": "string",
  • "work_address_postal_code": "string",
  • "alt_address_postal_code": "string",
  • "organization_id": "string",
  • "preferred_address": {
    },
  • "phone_numbers": [
    ],
  • "mobile_phone_number": "string",
  • "work_mobile_phone_number": "string",
  • "home_phone_number": "string",
  • "work_phone_number": "string",
  • "school_phone_number": "string",
  • "other_phone_numbers": [
    ],
  • "possible_duplicates": [
    ],
  • "number_of_possible_duplicates": 0,
  • "highest_confidence": 0,
  • "whitelist": [
    ],
  • "manual_duplicates": [
    ],
  • "sys_match_directive": "string",
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Search for potential duplicates in the portal

This method searches for potential duplicates and returns masked validation options

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed

Request Body schema: application/json

The data you would like to try to check for duplicates

email_address
string (Email Address)

The email address to search for matches

first_name
string (First Name)

The contact's first name

last_name
string (Last Name)

The contact's last name

postal_code
string (Postal Code)

The postal code to search for matches

minimum_confidence
number <float> (Minimum Confidence)

The minimum degree of confidence on a scale of 1 to 100 that you would like considered a potential duplicate

Responses
200Potential duplicates were retrieved successfully
400The search you supplied was invalid.
401Unauthorized
403Forbidden
404The resource could not be found
429Limit exceeded... unable to add order based on tenant limits.
500General server error
post/contactDuplicates/{tenantId}/portal
Request samples
    1 more
    Python
application/json
{
  • "email_address": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "postal_code": "string",
  • "minimum_confidence": 0
}
Response samples
application/json
[
  • {
    }
]

Execute Batch Operations

TAllows you to perform up to 100 parallel patch/delete operations

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

Request Body schema: application/json

The batch request

Array of objects
Responses
200Request completed successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The contact duplicate could not be found.
429Limit exceeded... unable to retrieve contact duplicate based on tenant limits.
500General server error.
post/contactDuplicates/{tenantId}/batch
Request samples
    1 more
    Python
application/json
{
  • "operations": [
    ]
}
Response samples
application/json
{
  • "success_count": 0,
  • "error_count": 0,
  • "results": [
    ]
}