Organization Duplicates

Organization Duplicates

Gets all of the organization duplicates in the system.

This method will scan all organization 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 organization duplicateswere retrieved successfully.
400The request was invalid.
401Unauthorized.
403Forbidden.
429Limit exceeded... unable to add contact role based on tenant limits.
500General server error.
get/organizationDuplicates/{tenantId}
Request samples
curl -i -X GET \
  'https://rolodex.api.756794052567.rhythmsoftware.com/organizationDuplicates/:tenantId?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Search for potential duplicates

This method takes in an order that has not yet been placed, and returns information about order pricing and available 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

name
required
string (Name)

The name of the organization

website
string (Website)

The url of the organization website

domain_name
string (Domain Name)

Domain names that are associated with this organization

main_phone_number
string (Main Phone Number)

The primary phone number

parent_organization_id
string (Parent Organization)

The parent organization of this one

facebook
string (Facebook)

Url to the organization's Facebook account

twitter
string (Twitter)

Url to the organization's Twitter account

linked_in
string (Linked In)

Url to the organization's LinkedIn account

address_postal_code
string (Address Postal Code)

The address postal code of the organization

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.
429Limit exceeded... unable to add order based on tenant limits.
500General server error
post/organizationDuplicates/{tenantId}
Request samples
    1 more
    Python
application/json
{
  • "name": "string",
  • "website": "string",
  • "domain_name": "string",
  • "main_phone_number": "string",
  • "parent_organization_id": "string",
  • "facebook": "string",
  • "twitter": "string",
  • "linked_in": "string",
  • "address_postal_code": "string",
  • "minimum_confidence": 0
}
Response samples
application/json
[
  • {
    }
]

Returns a organization duplicate from the system by its ID.

This method will look up a organization 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 organization 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 organization duplicate was retrieved successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The organization duplicate could not be found.
429Limit exceeded... unable to retrieve organization duplicate based on tenant limits.
500General server error.
get/organizationDuplicates/{tenantId}/{id}
Request samples
curl -i -X GET \
  'https://rolodex.api.756794052567.rhythmsoftware.com/organizationDuplicates/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "website": "string",
  • "domain_name": "string",
  • "main_phone_number": "string",
  • "parent_organization_id": "string",
  • "facebook": "string",
  • "twitter": "string",
  • "linked_in": "string",
  • "name_metaphones": [
    ],
  • "name_primary_metaphone": "string",
  • "name_secondary_metaphone": "string",
  • "address_postal_code": "string",
  • "possible_duplicates": [
    ],
  • "number_of_possible_duplicates": 0,
  • "highest_confidence": 0,
  • "whitelist": [
    ],
  • "manual_duplicates": [
    ],
  • "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_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string"
}

Updates a organization duplicate with the specified ID.

This method will update an existing organization 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 organization duplicate to update.

Request Body schema: application/json

The updated organization duplicate that will be saved.

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

The unique, string identifier of this organization

name
required
string (Name)

The name of the organization

website
string (Website)

The url of the organization website

domain_name
string (Domain Name)

Domain names that are associated with this organization

main_phone_number
string (Main Phone Number)

The primary phone number

parent_organization_id
string (Parent Organization)

The parent organization of this one

facebook
string (Facebook)

Url to the organization's Facebook account

twitter
string (Twitter)

Url to the organization's Twitter account

linked_in
string (Linked In)

Url to the organization's LinkedIn account

name_metaphones
Array of strings (Name Metaphones)

The metaphones calculated from the organization's name

name_primary_metaphone
string (Name Primary Metaphone)

The primary metaphone calculated from the organization's name

name_secondary_metaphone
string (Name Secondary Metaphone)

The secondary metaphone calculated from the organization's name

address_postal_code
string (Address Postal Code)

The address postal code of the organization

required
Array of objects

The organizations that are potentially duplicates of this organization

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
required
Array of strings (Whitelist)

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

manual_duplicates
required
Array of strings (Manual Duplicates)

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

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_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

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_configuration_snapshot_id
string (Sys Configuration Snapshot)

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

Responses
200The organization duplicate was updated successfully.
400The organization duplicate supplied was not valid.
401Unauthorized.
403Forbidden.
404The organization duplicate could not be found.
409The organization duplicate could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve organization duplicate based on tenant limits.
500General server error.
put/organizationDuplicates/{tenantId}/{id}
Request samples
    1 more
    Python
application/json
{
  • "id": "string",
  • "name": "string",
  • "website": "string",
  • "domain_name": "string",
  • "main_phone_number": "string",
  • "parent_organization_id": "string",
  • "facebook": "string",
  • "twitter": "string",
  • "linked_in": "string",
  • "name_metaphones": [
    ],
  • "name_primary_metaphone": "string",
  • "name_secondary_metaphone": "string",
  • "address_postal_code": "string",
  • "possible_duplicates": [
    ],
  • "number_of_possible_duplicates": 0,
  • "highest_confidence": 0,
  • "whitelist": [
    ],
  • "manual_duplicates": [
    ],
  • "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_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string"
}
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "website": "string",
  • "domain_name": "string",
  • "main_phone_number": "string",
  • "parent_organization_id": "string",
  • "facebook": "string",
  • "twitter": "string",
  • "linked_in": "string",
  • "name_metaphones": [
    ],
  • "name_primary_metaphone": "string",
  • "name_secondary_metaphone": "string",
  • "address_postal_code": "string",
  • "possible_duplicates": [
    ],
  • "number_of_possible_duplicates": 0,
  • "highest_confidence": 0,
  • "whitelist": [
    ],
  • "manual_duplicates": [
    ],
  • "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_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string"
}

Partially updates a organization duplicate with the specified ID.

This method will patch an existing organization 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 organization 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 organization duplicate was patched successfully.
400The JSON patch directive you supplied was not valid.
401Unauthorized.
403Forbidden.
404The organization duplicate could not be found.
409The organization duplicate could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve organization duplicate based on tenant limits.
500General server error.
patch/organizationDuplicates/{tenantId}/{id}
Request samples
    1 more
    Python
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "website": "string",
  • "domain_name": "string",
  • "main_phone_number": "string",
  • "parent_organization_id": "string",
  • "facebook": "string",
  • "twitter": "string",
  • "linked_in": "string",
  • "name_metaphones": [
    ],
  • "name_primary_metaphone": "string",
  • "name_secondary_metaphone": "string",
  • "address_postal_code": "string",
  • "possible_duplicates": [
    ],
  • "number_of_possible_duplicates": 0,
  • "highest_confidence": 0,
  • "whitelist": [
    ],
  • "manual_duplicates": [
    ],
  • "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_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string"
}