Relationship Intelligence

Relationship Intelligence APIs

The Relationship Intelligence APIs are designed to integrate email and meeting metadata into the relationship scoring and automated contact creation capabilities. These APIs provide create access to the email and meeting datasets that are core to Relationship Intelligence. In addition, these APIs provide read access to the relationship scoring settings and user sync statuses. Clients that use non-supported email software vendors or wish to have full control over the specific data shared to DealCloud’s Relationship Intelligence system can leverage these APIs in place of the standard email integration options.

List of Endpoints

POST /emails

Post email data to the Relationship Intelligence system for enabled users

POST /meetings

Post meeting data to the Relationship Intelligence system for enabled users

GET /status

Get user status data from the Relationship Intelligence system for enabled users

GET /settings

Get Relationship Intelligence settings related to the API Endpoints.

Preconditions

To use the Relationship Intelligence APIs, the following conditions must be met:

  1. The “API Endpoint” Connection Type must be selected within the primary Exchange Connection settings
  2. Relationship Intelligence must be enabled within the Exchange Connection settings
  3. The User account leveraging the API endpoints must have the “Access Web Service” and “Access 4. Relationship Intelligence” capabilities in User Management
  4. User(s) have been enabled for Relationship Intelligence in the Relationship Intelligence settings

To post email data to the endpoints, the following conditions must be met:

  1. Email Relationships must be enabled within the Relationship Intelligence settings
  2. Collect Relationship Data must be enabled within the Relationship Intelligence settings

To post meeting data to the endpoints, the following conditions must be met:

  1. Meeting Relationships must be enabled within the Relationship Intelligence settings
  2. Collect Relationship Data must be enabled within the Relationship Intelligence settings

To leverage the automated contact creation capability with the API endpoints, the following conditions must be met:

  1. Automated Contact Creation must be enabled in the Exchange Connection settings
  2. Display name must be included in the posted email and meeting data

Limits

The following general API limits apply to the Relationship Intelligence APIs:

  • Email and Meeting data must be upload in chronological order
    • Historical data can be uploaded based upon the historical sync period
    • Once historical data has been upload is complete, no additional historical data can be uploaded
    • Data for the previous month must be uploaded before 1AM the morning of the second day of the new month
  • Batch email and meeting posts are preferred over continuous API calls
    • Recommend posting email and meeting data between 2-12 times a day per user
    • Up to 1,000 emails per user can be included in a single request (up to 50,000 emails across all users in single request)
    • Up to 100 meetings per user can be included in a single request (up to 5,000 meetings across all users in a single request)
  • Users included in the request must be enabled for relationship scoring (note: the status endpoint can provide a list of enabled users)
  • Each email and meeting item for a given user within a request must have a unique ID
    • Email and meeting items do not have to be unique across users or across requests
    • Any duplicate items across users or across requests will be marked as “already processed.
  • Concurrent execution of requests is not allowed. Limit of 5 requests per minute allowed