Rolodex

Rolodex (Contacts & Organizations) (v1-2025-04-18)

The Contacts & Organizations, or Rolodex, app provides the Customer Relationship Management (CRM) capabilities of the Rhythm platform. Common integrations with the Rolodex API include finding or updating contact information, demographics, or communication preferences for a Contact or Organization.

Like most of the other Rhythm apps, the Rolodex API includes endpoints for Query Definitions. These endpoints are commonly used to retrieve saved queries, which can then be executed using the Query endpoints of the System API.

Download OpenAPI description

rolodex-v1.json

rolodex-v1.yaml

Servers

Mock server

https://docs.api.rhythmsoftware.com/_mock/apis/rolodex/rolodex-v1/

https://rolodex.api.rhythmsoftware.com/

Account Delegation Processes

Operations

Address Types

Operations

Communication Types

Operations

Contact Directories

Operations

Contact Districts

Operations

Contact Duplicates

Operations

Gets all of the contact duplicates in the system.

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

Query

fieldsstring

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

exclusiveStartKeystring

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

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/rolodex/rolodex-v1/contactDuplicates/{tenantId}?exclusiveStartKey=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The contact duplicateswere retrieved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/jsonArray [

alt_address_postal_codestring(Alt Address Postal Code)

An alternative address postal code of the contact

email_addressstring(Email Address)

The primary email address

email_address2string(Email Address2)

Secondary email address

email_address3string(Email Address3)

Tertiary email address

first_namestring(First Name)

The contact's first name

first_name_metaphonesArray of strings(First Name Metaphones)

The metaphones calculated from the contact's first name

first_name_primary_metaphonestring(First Name Primary Metaphone)

The primary metaphone calculated from the contact's first name

first_name_secondary_metaphonestring(First Name Secondary Metaphone)

The secondary metaphone calculated from the contact's first name

highest_confidencenumber(float)(Highest Confidence)

The highest confidence score within the possible duplicates excluding whitelisted records

home_address_postal_codestring(Home Address Postal Code)

The home address postal code of the contact

home_phone_numberstring(Home Phone Number)

Home phone number

idstring(ID)^[\w|-]+$required

The unique, string identifier of this contact

last_namestring(Last Name)

The contact's last name

last_name_metaphonesArray of strings(Last Name Metaphones)

The metaphones calculated from the contact's last name

last_name_primary_metaphonestring(Last Name Primary Metaphone)

The primary metaphone calculated from the contact's last name

last_name_secondary_metaphonestring(Last Name Secondary Metaphone)

The secondary metaphone calculated from the contact's last name

manual_duplicatesArray of strings(Manual Duplicates)

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

middle_namestring(Middle Name)

The contact's middle name

mobile_phone_numberstring(Mobile Phone Number)

Mobile phone number

number_of_possible_duplicatesnumber(float)(Number Of Possible Duplicates)

The number of possible duplicates excluding whitelisted records

organization_idstring(Organization)

The ID of the organization that the contact belongs to

other_phone_numbersArray of objects

phone_numbersArray of strings(Phone Numbers)

All of the contact's phone numbers

possible_duplicatesArray of objects

The contacts that are potentially duplicates of this contact

postal_codesArray of strings(Postal Codes)

The postal codes off all the contact's addresses

preferred_addressobject(Address)

A complete address

school_phone_numberstring(School Phone Number)

Fax phone number

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(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_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(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_last_bulk_data_operation_idstring(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_versionstring(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_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_match_directivestring(Sys Match Directive)

sys_snapshot_base_versionnumber(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_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

whitelistArray 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

work_address_postal_codestring(Work Address Postal Code)

The work address postal code of the contact

work_mobile_phone_numberstring(Work Mobile Phone Number)

Mobile phone number for business unit

work_phone_numberstring(Work Phone Number)

Work phone number

]

Response

application/json

[
  {
    "alt_address_postal_code": "string",
    "email_address": "string",
    "email_address2": "string",
    "email_address3": "string",
    "first_name": "string",
    "first_name_metaphones": [ … ],
    "first_name_primary_metaphone": "string",
    "first_name_secondary_metaphone": "string",
    "highest_confidence": 0.1,
    "home_address_postal_code": "string",
    "home_phone_number": "string",
    "id": "string",
    "last_name": "string",
    "last_name_metaphones": [ … ],
    "last_name_primary_metaphone": "string",
    "last_name_secondary_metaphone": "string",
    "manual_duplicates": [ … ],
    "middle_name": "string",
    "mobile_phone_number": "string",
    "number_of_possible_duplicates": 0.1,
    "organization_id": "string",
    "other_phone_numbers": [ … ],
    "phone_numbers": [ … ],
    "possible_duplicates": [ … ],
    "postal_codes": [ … ],
    "preferred_address": { … },
    "school_phone_number": "string",
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [ … ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_match_directive": "string",
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "whitelist": [ … ],
    "work_address_postal_code": "string",
    "work_mobile_phone_number": "string",
    "work_phone_number": "string"
  }
]

Search for potential duplicates

Request

This method searches for potential duplicates

Path

tenantIdstringrequired

The id of the tenant being accessed

Bodyapplication/jsonrequired

The data you would like to try to check for duplicates

alt_address_postal_codestring(Alt Address Postal Code)

An alternative address postal code of the contact

email_addressstring(Email Address)

The primary email address

email_address2string(Email Address2)

Secondary email address

email_address3string(Email Address3)

Tertiary email address

first_namestring(First Name)

The contact's first name

home_address_postal_codestring(Home Address Postal Code)

The home address postal code of the contact

last_namestring(Last Name)

The contact's last name

minimum_confidencenumber(float)(Minimum Confidence)

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

work_address_postal_codestring(Work Address Postal Code)

The work address postal code of the contact

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/rolodex/rolodex-v1/contactDuplicates/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "alt_address_postal_code": "string",
    "email_address": "string",
    "email_address2": "string",
    "email_address3": "string",
    "first_name": "string",
    "home_address_postal_code": "string",
    "last_name": "string",
    "minimum_confidence": 0.1,
    "work_address_postal_code": "string"
  }'

Responses

Potential duplicates were retrieved successfully

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/jsonArray [

confidencenumber(float)(Confidence)required

The likelihood that these two contacts are duplicates on a scale of 1 to 100

matchstring(Match)required

The ID of the contact that is a potential duplicate

]

Response

application/json

[
  {
    "confidence": 0.1,
    "match": "string"
  }
]

Execute Batch Operations

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The batch request

operationsArray of objects

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/rolodex/rolodex-v1/contactDuplicates/{tenantId}/batch' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "operations": [
      {
        "id": null,
        "object": {},
        "operation": "create",
        "patch_directives": {
          "0": {
            "op": "add",
            "path": "string",
            "value": "string"
          }
        }
      }
    ]
  }'

Responses

Request completed successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

error_countnumber(float)(Error Count)

Number of error results

resultsArray of objects

success_countnumber(float)(Success Count)

Number of successful results

Response

application/json

{
  "error_count": 0.1,
  "results": [
    { … }
  ],
  "success_count": 0.1
}

Search for potential duplicates in the portal

Request

This method searches for potential duplicates and returns masked validation options

Path

tenantIdstringrequired

The id of the tenant being accessed

Bodyapplication/jsonrequired

The data you would like to try to check for duplicates

email_addressstring(Email Address)

The email address to search for matches

first_namestring(First Name)

The contact's first name

last_namestring(Last Name)

The contact's last name

minimum_confidencenumber(float)(Minimum Confidence)

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

postal_codestring(Postal Code)

The postal code to search for matches

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/rolodex/rolodex-v1/contactDuplicates/{tenantId}/portal' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "email_address": "string",
    "first_name": "string",
    "last_name": "string",
    "minimum_confidence": 0.1,
    "postal_code": "string"
  }'

Responses

Potential duplicates were retrieved successfully

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/jsonArray [

idstring(ID)^[\w|-]+$required

The unique, string identifier of this contact

locationobject(Location)

Information off this contact's preferred address masked for data protection

masked_email_addressesArray of objects

Email addresses related to this contact masked for data protection

masked_phone_numbersArray of objects

Phone numbers related to this contact masked for data protection

namestring(Name)required

The name of the matched contact

organization_namestring(Organization Name)

The name of the organization this contact is related to

]

Response

application/json

[
  {
    "id": "string",
    "location": { … },
    "masked_email_addresses": [ … ],
    "masked_phone_numbers": [ … ],
    "name": "string",
    "organization_name": "string"
  }
]

Returns a contact duplicate from the system by its ID.

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the contact duplicate to return.

Query

fieldsstring

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

consistentReadstring

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

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/rolodex/rolodex-v1/contactDuplicates/{tenantId}/{id}?consistentRead=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The contact duplicate was retrieved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

alt_address_postal_codestring(Alt Address Postal Code)

An alternative address postal code of the contact

email_addressstring(Email Address)

The primary email address

email_address2string(Email Address2)

Secondary email address

email_address3string(Email Address3)

Tertiary email address

first_namestring(First Name)

The contact's first name

first_name_metaphonesArray of strings(First Name Metaphones)

The metaphones calculated from the contact's first name

first_name_primary_metaphonestring(First Name Primary Metaphone)

The primary metaphone calculated from the contact's first name

first_name_secondary_metaphonestring(First Name Secondary Metaphone)

The secondary metaphone calculated from the contact's first name

highest_confidencenumber(float)(Highest Confidence)

The highest confidence score within the possible duplicates excluding whitelisted records

home_address_postal_codestring(Home Address Postal Code)

The home address postal code of the contact

home_phone_numberstring(Home Phone Number)

Home phone number

idstring(ID)^[\w|-]+$required

The unique, string identifier of this contact

last_namestring(Last Name)

The contact's last name

last_name_metaphonesArray of strings(Last Name Metaphones)

The metaphones calculated from the contact's last name

last_name_primary_metaphonestring(Last Name Primary Metaphone)

The primary metaphone calculated from the contact's last name

last_name_secondary_metaphonestring(Last Name Secondary Metaphone)

The secondary metaphone calculated from the contact's last name

manual_duplicatesArray of strings(Manual Duplicates)

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

middle_namestring(Middle Name)

The contact's middle name

mobile_phone_numberstring(Mobile Phone Number)

Mobile phone number

number_of_possible_duplicatesnumber(float)(Number Of Possible Duplicates)

The number of possible duplicates excluding whitelisted records

organization_idstring(Organization)

The ID of the organization that the contact belongs to

other_phone_numbersArray of objects

phone_numbersArray of strings(Phone Numbers)

All of the contact's phone numbers

possible_duplicatesArray of objects

The contacts that are potentially duplicates of this contact

postal_codesArray of strings(Postal Codes)

The postal codes off all the contact's addresses

preferred_addressobject(Address)

A complete address

school_phone_numberstring(School Phone Number)

Fax phone number

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(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_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(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_last_bulk_data_operation_idstring(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_versionstring(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_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_match_directivestring(Sys Match Directive)

sys_snapshot_base_versionnumber(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_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

whitelistArray 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

work_address_postal_codestring(Work Address Postal Code)

The work address postal code of the contact

work_mobile_phone_numberstring(Work Mobile Phone Number)

Mobile phone number for business unit

work_phone_numberstring(Work Phone Number)

Work phone number

Response

application/json

{
  "alt_address_postal_code": "string",
  "email_address": "string",
  "email_address2": "string",
  "email_address3": "string",
  "first_name": "string",
  "first_name_metaphones": [
    "string"
  ],
  "first_name_primary_metaphone": "string",
  "first_name_secondary_metaphone": "string",
  "highest_confidence": 0.1,
  "home_address_postal_code": "string",
  "home_phone_number": "string",
  "id": "string",
  "last_name": "string",
  "last_name_metaphones": [
    "string"
  ],
  "last_name_primary_metaphone": "string",
  "last_name_secondary_metaphone": "string",
  "manual_duplicates": [
    "string"
  ],
  "middle_name": "string",
  "mobile_phone_number": "string",
  "number_of_possible_duplicates": 0.1,
  "organization_id": "string",
  "other_phone_numbers": [
    { … }
  ],
  "phone_numbers": [
    "string"
  ],
  "possible_duplicates": [
    { … }
  ],
  "postal_codes": [
    "string"
  ],
  "preferred_address": {
    "city": "string",
    "country": "string",
    "country_name": "string",
    "county": "string",
    "latitude": 0.1,
    "line1": "string",
    "line2": "string",
    "line3": "string",
    "longitude": 0.1,
    "postal_code": "string",
    "state": "string",
    "time_zone_id": "string"
  },
  "school_phone_number": "string",
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_match_directive": "string",
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "whitelist": [
    "string"
  ],
  "work_address_postal_code": "string",
  "work_mobile_phone_number": "string",
  "work_phone_number": "string"
}

Partially updates a contact duplicate with the specified ID.

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the contact duplicate to patch.

Bodyapplication/jsonrequired

The patch directives conforming to RFC 6902.

Array [

opstring(Op)required

The operation

Enum"add""copy""move""remove""replace""test"

pathstring(Path)required

The JSON path

valuestring(Value)

The updated value

]

curl -i -X PATCH \
  'https://docs.api.rhythmsoftware.com/_mock/apis/rolodex/rolodex-v1/contactDuplicates/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "op": "add",
      "path": "string",
      "value": "string"
    }
  ]'

Responses

The contact duplicate was patched successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

alt_address_postal_codestring(Alt Address Postal Code)

An alternative address postal code of the contact

email_addressstring(Email Address)

The primary email address

email_address2string(Email Address2)

Secondary email address

email_address3string(Email Address3)

Tertiary email address

first_namestring(First Name)

The contact's first name

first_name_metaphonesArray of strings(First Name Metaphones)

The metaphones calculated from the contact's first name

first_name_primary_metaphonestring(First Name Primary Metaphone)

The primary metaphone calculated from the contact's first name

first_name_secondary_metaphonestring(First Name Secondary Metaphone)

The secondary metaphone calculated from the contact's first name

highest_confidencenumber(float)(Highest Confidence)

The highest confidence score within the possible duplicates excluding whitelisted records

home_address_postal_codestring(Home Address Postal Code)

The home address postal code of the contact

home_phone_numberstring(Home Phone Number)

Home phone number

idstring(ID)^[\w|-]+$required

The unique, string identifier of this contact

last_namestring(Last Name)

The contact's last name

last_name_metaphonesArray of strings(Last Name Metaphones)

The metaphones calculated from the contact's last name

last_name_primary_metaphonestring(Last Name Primary Metaphone)

The primary metaphone calculated from the contact's last name

last_name_secondary_metaphonestring(Last Name Secondary Metaphone)

The secondary metaphone calculated from the contact's last name

manual_duplicatesArray of strings(Manual Duplicates)

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

middle_namestring(Middle Name)

The contact's middle name

mobile_phone_numberstring(Mobile Phone Number)

Mobile phone number

number_of_possible_duplicatesnumber(float)(Number Of Possible Duplicates)

The number of possible duplicates excluding whitelisted records

organization_idstring(Organization)

The ID of the organization that the contact belongs to

other_phone_numbersArray of objects

phone_numbersArray of strings(Phone Numbers)

All of the contact's phone numbers

possible_duplicatesArray of objects

The contacts that are potentially duplicates of this contact

postal_codesArray of strings(Postal Codes)

The postal codes off all the contact's addresses

preferred_addressobject(Address)

A complete address

school_phone_numberstring(School Phone Number)

Fax phone number

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(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_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(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_last_bulk_data_operation_idstring(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_versionstring(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_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_match_directivestring(Sys Match Directive)

sys_snapshot_base_versionnumber(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_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

whitelistArray 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

work_address_postal_codestring(Work Address Postal Code)

The work address postal code of the contact

work_mobile_phone_numberstring(Work Mobile Phone Number)

Mobile phone number for business unit

work_phone_numberstring(Work Phone Number)

Work phone number

Response

application/json

{
  "alt_address_postal_code": "string",
  "email_address": "string",
  "email_address2": "string",
  "email_address3": "string",
  "first_name": "string",
  "first_name_metaphones": [
    "string"
  ],
  "first_name_primary_metaphone": "string",
  "first_name_secondary_metaphone": "string",
  "highest_confidence": 0.1,
  "home_address_postal_code": "string",
  "home_phone_number": "string",
  "id": "string",
  "last_name": "string",
  "last_name_metaphones": [
    "string"
  ],
  "last_name_primary_metaphone": "string",
  "last_name_secondary_metaphone": "string",
  "manual_duplicates": [
    "string"
  ],
  "middle_name": "string",
  "mobile_phone_number": "string",
  "number_of_possible_duplicates": 0.1,
  "organization_id": "string",
  "other_phone_numbers": [
    { … }
  ],
  "phone_numbers": [
    "string"
  ],
  "possible_duplicates": [
    { … }
  ],
  "postal_codes": [
    "string"
  ],
  "preferred_address": {
    "city": "string",
    "country": "string",
    "country_name": "string",
    "county": "string",
    "latitude": 0.1,
    "line1": "string",
    "line2": "string",
    "line3": "string",
    "longitude": 0.1,
    "postal_code": "string",
    "state": "string",
    "time_zone_id": "string"
  },
  "school_phone_number": "string",
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_match_directive": "string",
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "whitelist": [
    "string"
  ],
  "work_address_postal_code": "string",
  "work_mobile_phone_number": "string",
  "work_phone_number": "string"
}

Updates a contact duplicate with the specified ID.

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the contact duplicate to update.

Bodyapplication/jsonrequired

The updated contact duplicate that will be saved.

alt_address_postal_codestring(Alt Address Postal Code)

An alternative address postal code of the contact

email_addressstring(Email Address)

The primary email address

email_address2string(Email Address2)

Secondary email address

email_address3string(Email Address3)

Tertiary email address

first_namestring(First Name)

The contact's first name

first_name_metaphonesArray of strings(First Name Metaphones)

The metaphones calculated from the contact's first name

first_name_primary_metaphonestring(First Name Primary Metaphone)

The primary metaphone calculated from the contact's first name

first_name_secondary_metaphonestring(First Name Secondary Metaphone)

The secondary metaphone calculated from the contact's first name

highest_confidencenumber(float)(Highest Confidence)

The highest confidence score within the possible duplicates excluding whitelisted records

home_address_postal_codestring(Home Address Postal Code)

The home address postal code of the contact

home_phone_numberstring(Home Phone Number)

Home phone number

idstring(ID)^[\w|-]+$required

The unique, string identifier of this contact

last_namestring(Last Name)

The contact's last name

last_name_metaphonesArray of strings(Last Name Metaphones)

The metaphones calculated from the contact's last name

last_name_primary_metaphonestring(Last Name Primary Metaphone)

The primary metaphone calculated from the contact's last name

last_name_secondary_metaphonestring(Last Name Secondary Metaphone)

The secondary metaphone calculated from the contact's last name

manual_duplicatesArray of strings(Manual Duplicates)

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

middle_namestring(Middle Name)

The contact's middle name

mobile_phone_numberstring(Mobile Phone Number)

Mobile phone number

number_of_possible_duplicatesnumber(float)(Number Of Possible Duplicates)

The number of possible duplicates excluding whitelisted records

organization_idstring(Organization)

The ID of the organization that the contact belongs to

other_phone_numbersArray of objects

phone_numbersArray of strings(Phone Numbers)

All of the contact's phone numbers

possible_duplicatesArray of objects

The contacts that are potentially duplicates of this contact

postal_codesArray of strings(Postal Codes)

The postal codes off all the contact's addresses

preferred_addressobject(Address)

A complete address

school_phone_numberstring(School Phone Number)

Fax phone number

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(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_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(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_last_bulk_data_operation_idstring(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_versionstring(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_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_match_directivestring(Sys Match Directive)

sys_snapshot_base_versionnumber(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_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

whitelistArray 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

work_address_postal_codestring(Work Address Postal Code)

The work address postal code of the contact

work_mobile_phone_numberstring(Work Mobile Phone Number)

Mobile phone number for business unit

work_phone_numberstring(Work Phone Number)

Work phone number

curl -i -X PUT \
  'https://docs.api.rhythmsoftware.com/_mock/apis/rolodex/rolodex-v1/contactDuplicates/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "alt_address_postal_code": "string",
    "email_address": "string",
    "email_address2": "string",
    "email_address3": "string",
    "first_name": "string",
    "first_name_metaphones": [
      "string"
    ],
    "first_name_primary_metaphone": "string",
    "first_name_secondary_metaphone": "string",
    "highest_confidence": 0.1,
    "home_address_postal_code": "string",
    "home_phone_number": "string",
    "id": "string",
    "last_name": "string",
    "last_name_metaphones": [
      "string"
    ],
    "last_name_primary_metaphone": "string",
    "last_name_secondary_metaphone": "string",
    "manual_duplicates": [
      "string"
    ],
    "middle_name": "string",
    "mobile_phone_number": "string",
    "number_of_possible_duplicates": 0.1,
    "organization_id": "string",
    "other_phone_numbers": [
      {
        "phone_number": "string",
        "type_id": "string"
      }
    ],
    "phone_numbers": [
      "string"
    ],
    "possible_duplicates": [
      {
        "confidence": 0.1,
        "match": "string"
      }
    ],
    "postal_codes": [
      "string"
    ],
    "preferred_address": {
      "city": "string",
      "country": "string",
      "country_name": "string",
      "county": "string",
      "latitude": 0.1,
      "line1": "string",
      "line2": "string",
      "line3": "string",
      "longitude": 0.1,
      "postal_code": "string",
      "state": "string",
      "time_zone_id": "string"
    },
    "school_phone_number": "string",
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_match_directive": "string",
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "whitelist": [
      "string"
    ],
    "work_address_postal_code": "string",
    "work_mobile_phone_number": "string",
    "work_phone_number": "string"
  }'

Responses

The contact duplicate was updated successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

alt_address_postal_codestring(Alt Address Postal Code)

An alternative address postal code of the contact

email_addressstring(Email Address)

The primary email address

email_address2string(Email Address2)

Secondary email address

email_address3string(Email Address3)

Tertiary email address

first_namestring(First Name)

The contact's first name

first_name_metaphonesArray of strings(First Name Metaphones)

The metaphones calculated from the contact's first name

first_name_primary_metaphonestring(First Name Primary Metaphone)

The primary metaphone calculated from the contact's first name

first_name_secondary_metaphonestring(First Name Secondary Metaphone)

The secondary metaphone calculated from the contact's first name

highest_confidencenumber(float)(Highest Confidence)

The highest confidence score within the possible duplicates excluding whitelisted records

home_address_postal_codestring(Home Address Postal Code)

The home address postal code of the contact

home_phone_numberstring(Home Phone Number)

Home phone number

idstring(ID)^[\w|-]+$required

The unique, string identifier of this contact

last_namestring(Last Name)

The contact's last name

last_name_metaphonesArray of strings(Last Name Metaphones)

The metaphones calculated from the contact's last name

last_name_primary_metaphonestring(Last Name Primary Metaphone)

The primary metaphone calculated from the contact's last name

last_name_secondary_metaphonestring(Last Name Secondary Metaphone)

The secondary metaphone calculated from the contact's last name

manual_duplicatesArray of strings(Manual Duplicates)

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

middle_namestring(Middle Name)

The contact's middle name

mobile_phone_numberstring(Mobile Phone Number)

Mobile phone number

number_of_possible_duplicatesnumber(float)(Number Of Possible Duplicates)

The number of possible duplicates excluding whitelisted records

organization_idstring(Organization)

The ID of the organization that the contact belongs to

other_phone_numbersArray of objects

phone_numbersArray of strings(Phone Numbers)

All of the contact's phone numbers

possible_duplicatesArray of objects

The contacts that are potentially duplicates of this contact

postal_codesArray of strings(Postal Codes)

The postal codes off all the contact's addresses

preferred_addressobject(Address)

A complete address

school_phone_numberstring(School Phone Number)

Fax phone number

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(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_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(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_last_bulk_data_operation_idstring(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_versionstring(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_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_match_directivestring(Sys Match Directive)

sys_snapshot_base_versionnumber(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_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

whitelistArray 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

work_address_postal_codestring(Work Address Postal Code)

The work address postal code of the contact

work_mobile_phone_numberstring(Work Mobile Phone Number)

Mobile phone number for business unit

work_phone_numberstring(Work Phone Number)

Work phone number

Response

application/json

{
  "alt_address_postal_code": "string",
  "email_address": "string",
  "email_address2": "string",
  "email_address3": "string",
  "first_name": "string",
  "first_name_metaphones": [
    "string"
  ],
  "first_name_primary_metaphone": "string",
  "first_name_secondary_metaphone": "string",
  "highest_confidence": 0.1,
  "home_address_postal_code": "string",
  "home_phone_number": "string",
  "id": "string",
  "last_name": "string",
  "last_name_metaphones": [
    "string"
  ],
  "last_name_primary_metaphone": "string",
  "last_name_secondary_metaphone": "string",
  "manual_duplicates": [
    "string"
  ],
  "middle_name": "string",
  "mobile_phone_number": "string",
  "number_of_possible_duplicates": 0.1,
  "organization_id": "string",
  "other_phone_numbers": [
    { … }
  ],
  "phone_numbers": [
    "string"
  ],
  "possible_duplicates": [
    { … }
  ],
  "postal_codes": [
    "string"
  ],
  "preferred_address": {
    "city": "string",
    "country": "string",
    "country_name": "string",
    "county": "string",
    "latitude": 0.1,
    "line1": "string",
    "line2": "string",
    "line3": "string",
    "longitude": 0.1,
    "postal_code": "string",
    "state": "string",
    "time_zone_id": "string"
  },
  "school_phone_number": "string",
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_match_directive": "string",
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "whitelist": [
    "string"
  ],
  "work_address_postal_code": "string",
  "work_mobile_phone_number": "string",
  "work_phone_number": "string"
}

Contact Login Profiles

Operations

Contact Role Rule Sets

Operations

Contact Roles

Operations

Contacts

Operations

Custom Activities

Operations

Custom Activity Types

Operations

Custom Engagement Metrics

Operations

Engagement Categories

Operations

Engagement Models

Operations

Engagement Scores

Operations

Organization Directories

Operations

Organization Duplicates

Operations

Organization Types

Operations

Organizations

Operations

Phone Number Types

Operations

Query Definitions

Operations

Region Configurations

Operations

Regions

Operations

Relationship Types

Operations

Relationships

Operations

Settings

Operations

Statistics

Operations

Rolodex (Contacts & Organizations) (v1-2025-04-18)

Account Delegation Processes

Address Types

Communication Types

Contact Directories

Contact Districts

Contact Duplicates

Gets all of the contact duplicates in the system.

Request

Responses

Was this helpful?

Search for potential duplicates

Request

Responses

Was this helpful?

Execute Batch Operations

RequestExpand all

Responses

Was this helpful?

Search for potential duplicates in the portal

Request

Responses

Was this helpful?

Returns a contact duplicate from the system by its ID.

Request

Responses

Was this helpful?

Partially updates a contact duplicate with the specified ID.

Request

Responses

Was this helpful?

Updates a contact duplicate with the specified ID.

RequestExpand all

Responses

Was this helpful?

Contact Login Profiles

Contact Role Rule Sets

Contact Roles

Contacts

Custom Activities

Custom Activity Types

Custom Engagement Metrics

Engagement Categories

Engagement Models

Engagement Scores

Organization Directories

Organization Duplicates

Organization Types

Organizations

Phone Number Types

Query Definitions

Region Configurations

Regions

Relationship Types

Relationships

Settings

Statistics

Request

Request