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

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

Gets all of the organization duplicates in the system.

Request

This method will scan all organization 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/organizationDuplicates/{tenantId}?exclusiveStartKey=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The organization duplicateswere retrieved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/jsonArray [

address_postal_codestring(Address Postal Code)

The address postal code of the organization

domain_namestring(Domain Name)

Domain names that are associated with this organization

facebookstring(Facebook)

Url to the organization's Facebook account

highest_confidencenumber(float)(Highest Confidence)

The highest confidence score within the possible duplicates excluding whitelisted records

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

The unique, string identifier of this organization

linked_instring(Linked In)

Url to the organization's LinkedIn account

main_phone_numberstring(Main Phone Number)

The primary phone number

manual_duplicatesArray of strings(Manual Duplicates)required

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

namestring(Name)required

The name of the organization

name_metaphonesArray of strings(Name Metaphones)

The metaphones calculated from the organization's name

name_primary_metaphonestring(Name Primary Metaphone)

The primary metaphone calculated from the organization's name

name_secondary_metaphonestring(Name Secondary Metaphone)

The secondary metaphone calculated from the organization's name

number_of_possible_duplicatesnumber(float)(Number Of Possible Duplicates)

The number of possible duplicates excluding whitelisted records

parent_organization_idstring(Parent Organization)

The parent organization of this one

possible_duplicatesArray of objectsrequired

The organizations that are potentially duplicates of this organization

possible_duplicates[].confidencenumber(float)(Confidence)required

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

possible_duplicates[].matchstring(Match)required

The ID of a organization that is potentially a duplicate of this organization

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_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_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_lockedboolean(Sys Locked)

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

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

twitterstring(Twitter)

Url to the organization's Twitter account

websitestring(Website)

The url of the organization website

whitelistArray of strings(Whitelist)required

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

]

Response

application/json

[
  {
    "address_postal_code": "string",
    "domain_name": "string",
    "facebook": "string",
    "highest_confidence": 0.1,
    "id": "string",
    "linked_in": "string",
    "main_phone_number": "string",
    "manual_duplicates": [ … ],
    "name": "string",
    "name_metaphones": [ … ],
    "name_primary_metaphone": "string",
    "name_secondary_metaphone": "string",
    "number_of_possible_duplicates": 0.1,
    "parent_organization_id": "string",
    "possible_duplicates": [ … ],
    "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_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_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "twitter": "string",
    "website": "string",
    "whitelist": [ … ]
  }
]

Search for potential duplicates

Request

This method takes in an order that has not yet been placed, and returns information about order pricing and available options

Path

tenantIdstringrequired

The id of the tenant being accessed

Bodyapplication/jsonrequired

The data you would like to try to check for duplicates

address_postal_codestring(Address Postal Code)

The address postal code of the organization

domain_namestring(Domain Name)

Domain names that are associated with this organization

facebookstring(Facebook)

Url to the organization's Facebook account

linked_instring(Linked In)

Url to the organization's LinkedIn account

main_phone_numberstring(Main Phone Number)

The primary phone number

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

namestring(Name)required

The name of the organization

parent_organization_idstring(Parent Organization)

The parent organization of this one

twitterstring(Twitter)

Url to the organization's Twitter account

websitestring(Website)

The url of the organization website

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/rolodex/rolodex-v1/organizationDuplicates/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "address_postal_code": "string",
    "domain_name": "string",
    "facebook": "string",
    "linked_in": "string",
    "main_phone_number": "string",
    "minimum_confidence": 0.1,
    "name": "string",
    "parent_organization_id": "string",
    "twitter": "string",
    "website": "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 organizations are duplicates on a scale of 1 to 100

matchstring(Match)required

The ID of the organization that is a potential duplicate

]

Response

application/json

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

Returns a organization duplicate from the system by its ID.

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the organization 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/organizationDuplicates/{tenantId}/{id}?consistentRead=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The organization duplicate was retrieved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

address_postal_codestring(Address Postal Code)

The address postal code of the organization

domain_namestring(Domain Name)

Domain names that are associated with this organization

facebookstring(Facebook)

Url to the organization's Facebook account

highest_confidencenumber(float)(Highest Confidence)

The highest confidence score within the possible duplicates excluding whitelisted records

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

The unique, string identifier of this organization

linked_instring(Linked In)

Url to the organization's LinkedIn account

main_phone_numberstring(Main Phone Number)

The primary phone number

manual_duplicatesArray of strings(Manual Duplicates)required

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

namestring(Name)required

The name of the organization

name_metaphonesArray of strings(Name Metaphones)

The metaphones calculated from the organization's name

name_primary_metaphonestring(Name Primary Metaphone)

The primary metaphone calculated from the organization's name

name_secondary_metaphonestring(Name Secondary Metaphone)

The secondary metaphone calculated from the organization's name

number_of_possible_duplicatesnumber(float)(Number Of Possible Duplicates)

The number of possible duplicates excluding whitelisted records

parent_organization_idstring(Parent Organization)

The parent organization of this one

possible_duplicatesArray of objectsrequired

The organizations that are potentially duplicates of this organization

possible_duplicates[].confidencenumber(float)(Confidence)required

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

possible_duplicates[].matchstring(Match)required

The ID of a organization that is potentially a duplicate of this organization

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_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_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_lockedboolean(Sys Locked)

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

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

twitterstring(Twitter)

Url to the organization's Twitter account

websitestring(Website)

The url of the organization website

whitelistArray of strings(Whitelist)required

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

Response

application/json

{
  "address_postal_code": "string",
  "domain_name": "string",
  "facebook": "string",
  "highest_confidence": 0.1,
  "id": "string",
  "linked_in": "string",
  "main_phone_number": "string",
  "manual_duplicates": [
    "string"
  ],
  "name": "string",
  "name_metaphones": [
    "string"
  ],
  "name_primary_metaphone": "string",
  "name_secondary_metaphone": "string",
  "number_of_possible_duplicates": 0.1,
  "parent_organization_id": "string",
  "possible_duplicates": [
    { … }
  ],
  "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_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_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "twitter": "string",
  "website": "string",
  "whitelist": [
    "string"
  ]
}

Partially updates a organization duplicate with the specified ID.

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the organization 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/organizationDuplicates/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "op": "add",
      "path": "string",
      "value": "string"
    }
  ]'

Responses

The organization duplicate was patched successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

address_postal_codestring(Address Postal Code)

The address postal code of the organization

domain_namestring(Domain Name)

Domain names that are associated with this organization

facebookstring(Facebook)

Url to the organization's Facebook account

highest_confidencenumber(float)(Highest Confidence)

The highest confidence score within the possible duplicates excluding whitelisted records

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

The unique, string identifier of this organization

linked_instring(Linked In)

Url to the organization's LinkedIn account

main_phone_numberstring(Main Phone Number)

The primary phone number

manual_duplicatesArray of strings(Manual Duplicates)required

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

namestring(Name)required

The name of the organization

name_metaphonesArray of strings(Name Metaphones)

The metaphones calculated from the organization's name

name_primary_metaphonestring(Name Primary Metaphone)

The primary metaphone calculated from the organization's name

name_secondary_metaphonestring(Name Secondary Metaphone)

The secondary metaphone calculated from the organization's name

number_of_possible_duplicatesnumber(float)(Number Of Possible Duplicates)

The number of possible duplicates excluding whitelisted records

parent_organization_idstring(Parent Organization)

The parent organization of this one

possible_duplicatesArray of objectsrequired

The organizations that are potentially duplicates of this organization

possible_duplicates[].confidencenumber(float)(Confidence)required

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

possible_duplicates[].matchstring(Match)required

The ID of a organization that is potentially a duplicate of this organization

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_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_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_lockedboolean(Sys Locked)

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

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

twitterstring(Twitter)

Url to the organization's Twitter account

websitestring(Website)

The url of the organization website

whitelistArray of strings(Whitelist)required

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

Response

application/json

{
  "address_postal_code": "string",
  "domain_name": "string",
  "facebook": "string",
  "highest_confidence": 0.1,
  "id": "string",
  "linked_in": "string",
  "main_phone_number": "string",
  "manual_duplicates": [
    "string"
  ],
  "name": "string",
  "name_metaphones": [
    "string"
  ],
  "name_primary_metaphone": "string",
  "name_secondary_metaphone": "string",
  "number_of_possible_duplicates": 0.1,
  "parent_organization_id": "string",
  "possible_duplicates": [
    { … }
  ],
  "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_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_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "twitter": "string",
  "website": "string",
  "whitelist": [
    "string"
  ]
}

Updates a organization duplicate with the specified ID.

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the organization duplicate to update.

Bodyapplication/jsonrequired

The updated organization duplicate that will be saved.

address_postal_codestring(Address Postal Code)

The address postal code of the organization

domain_namestring(Domain Name)

Domain names that are associated with this organization

facebookstring(Facebook)

Url to the organization's Facebook account

highest_confidencenumber(float)(Highest Confidence)

The highest confidence score within the possible duplicates excluding whitelisted records

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

The unique, string identifier of this organization

linked_instring(Linked In)

Url to the organization's LinkedIn account

main_phone_numberstring(Main Phone Number)

The primary phone number

manual_duplicatesArray of strings(Manual Duplicates)required

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

namestring(Name)required

The name of the organization

name_metaphonesArray of strings(Name Metaphones)

The metaphones calculated from the organization's name

name_primary_metaphonestring(Name Primary Metaphone)

The primary metaphone calculated from the organization's name

name_secondary_metaphonestring(Name Secondary Metaphone)

The secondary metaphone calculated from the organization's name

number_of_possible_duplicatesnumber(float)(Number Of Possible Duplicates)

The number of possible duplicates excluding whitelisted records

parent_organization_idstring(Parent Organization)

The parent organization of this one

possible_duplicatesArray of objectsrequired

The organizations that are potentially duplicates of this organization

possible_duplicates[].confidencenumber(float)(Confidence)required

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

possible_duplicates[].matchstring(Match)required

The ID of a organization that is potentially a duplicate of this organization

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_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_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_lockedboolean(Sys Locked)

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

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

twitterstring(Twitter)

Url to the organization's Twitter account

websitestring(Website)

The url of the organization website

whitelistArray of strings(Whitelist)required

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

curl -i -X PUT \
  'https://docs.api.rhythmsoftware.com/_mock/apis/rolodex/rolodex-v1/organizationDuplicates/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "address_postal_code": "string",
    "domain_name": "string",
    "facebook": "string",
    "highest_confidence": 0.1,
    "id": "string",
    "linked_in": "string",
    "main_phone_number": "string",
    "manual_duplicates": [
      "string"
    ],
    "name": "string",
    "name_metaphones": [
      "string"
    ],
    "name_primary_metaphone": "string",
    "name_secondary_metaphone": "string",
    "number_of_possible_duplicates": 0.1,
    "parent_organization_id": "string",
    "possible_duplicates": [
      {
        "confidence": 0.1,
        "match": "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_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_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "twitter": "string",
    "website": "string",
    "whitelist": [
      "string"
    ]
  }'

Responses

The organization duplicate was updated successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

address_postal_codestring(Address Postal Code)

The address postal code of the organization

domain_namestring(Domain Name)

Domain names that are associated with this organization

facebookstring(Facebook)

Url to the organization's Facebook account

highest_confidencenumber(float)(Highest Confidence)

The highest confidence score within the possible duplicates excluding whitelisted records

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

The unique, string identifier of this organization

linked_instring(Linked In)

Url to the organization's LinkedIn account

main_phone_numberstring(Main Phone Number)

The primary phone number

manual_duplicatesArray of strings(Manual Duplicates)required

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

namestring(Name)required

The name of the organization

name_metaphonesArray of strings(Name Metaphones)

The metaphones calculated from the organization's name

name_primary_metaphonestring(Name Primary Metaphone)

The primary metaphone calculated from the organization's name

name_secondary_metaphonestring(Name Secondary Metaphone)

The secondary metaphone calculated from the organization's name

number_of_possible_duplicatesnumber(float)(Number Of Possible Duplicates)

The number of possible duplicates excluding whitelisted records

parent_organization_idstring(Parent Organization)

The parent organization of this one

possible_duplicatesArray of objectsrequired

The organizations that are potentially duplicates of this organization

possible_duplicates[].confidencenumber(float)(Confidence)required

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

possible_duplicates[].matchstring(Match)required

The ID of a organization that is potentially a duplicate of this organization

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_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_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_lockedboolean(Sys Locked)

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

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

twitterstring(Twitter)

Url to the organization's Twitter account

websitestring(Website)

The url of the organization website

whitelistArray of strings(Whitelist)required

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

Response

application/json

{
  "address_postal_code": "string",
  "domain_name": "string",
  "facebook": "string",
  "highest_confidence": 0.1,
  "id": "string",
  "linked_in": "string",
  "main_phone_number": "string",
  "manual_duplicates": [
    "string"
  ],
  "name": "string",
  "name_metaphones": [
    "string"
  ],
  "name_primary_metaphone": "string",
  "name_secondary_metaphone": "string",
  "number_of_possible_duplicates": 0.1,
  "parent_organization_id": "string",
  "possible_duplicates": [
    { … }
  ],
  "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_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_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "twitter": "string",
  "website": "string",
  "whitelist": [
    "string"
  ]
}

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

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

Gets all of the organization duplicates in the system.

Request

Responses

Was this helpful?

Search for potential duplicates

Request

Responses

Was this helpful?

Returns a organization duplicate from the system by its ID.

Request

Responses

Was this helpful?

Partially updates a organization duplicate with the specified ID.

Request

Responses

Was this helpful?

Updates a organization duplicate with the specified ID.

RequestExpand all

Responses

Was this helpful?

Organization Types

Organizations

Phone Number Types

Query Definitions

Region Configurations

Regions

Relationship Types

Relationships

Settings

Statistics

Request