DealCloud API Release Notes

2409 - September Release

The Publication API now returns the EntryName of records in addition to their EntryId. The EntryName is only included for ROWS format custom Publication topics, not for default topics. This change makes it easier to tell at a glance which entry was affected.

2407 - July Release

Default Topics Appear on the Publications Page UI The three default publication topics - default-data, default-users, and default-schema are now shown on the Publications page, offering administrators a clearer view into the events streaming from DealCloud.

2404 - April Release

Field Filtering for Publication Events

When editing a Publications topics, administrators can now choose which fields they receive Publication events for. In the Field Settings (optional) column, clicking Edit allows administrators to select the fields for which the API should stream updates. After configuring field filters, the number of fields selected is shown in the Selected column.
See more

2403 - March Release

Available as of March 16, 2024

Relationship Intelligence APIs

• New API endpoints are available that enable you to deliver email and meeting metadata to DealCloud for processing and analysis by the Relationship Intelligence service (released in 2401).
• Documentation now available here

Core

• The User object model now includes a reference to the UserEntryID, which may not always be the same as the EntryID for the user entry.
• The /allHistory endpoint now tracks reference change events such as those caused by merged entries. For example, if two records are merged and the resulting record has an updated value that is referenced by other records, the records that reference that merged entry will be shown as modified by the /allHistory endpoint.

2402 - February Release

Available as of February 17, 2024

API Change History Settings

1. API administrators can now view additional field types on the Change History Settings page (Site Settings → Firm Settings → API Audit History Settings → Change History Settings), allowing them to keep track of audit log enablement and disablement for API updates more accurately.

2. For integrations sending a large volume of updates or repeat values to fields, admins may notice those fields are automatically excluded from API history tracking. For those fields, the Modified By column will show Integration Check Service. We encourage admins to resolve the integration flow before re-enabling them for API history tracking.

2401 - January Release

Available as of January 20, 2024

Relationship Intelligence APIs

1. New API endpoints are available that enable you to deliver email and meeting metadata to DealCloud for processing and analysis by the Relationship Intelligence service. For organizations that do not have a supported Microsoft Exchange connection or prefer to communicate through APIs, use this capability to deliver the metadata that is needed for identifying the connections between your organization and external contacts and analyzing and scoring those relationships.

Publications API

1. Schema Versioning: A new schemaVersion property has been added to data and schema event responses. This property denotes the current site schema version.

2. Calculated Events: A new isCalculated boolean attribute has been added to the payload of data events. If the event reflects a calculation update, the value of this attribute is set to true.

2312 - December Release

Available as of December 16, 2023

1. Filter by exportDataType for User Activity API A new exportDataType body parameter has been added to the POST /api/rest/v1/management/user/activity API endpoint. This parameter allows the API to filter for the different types of exportData, ensuring more accurate user activity tracking and reporting

2310 - October Release

Available as of October 21, 2023

1. Set Users Created by API to Active or Inactive
   Users created via API can now be set to either active or inactive rather than always being active by default. A new isActive property has been added to the user creation endpoint. When this property is set to false, the user created by the API is set to Inactive. If the property is set to true or not specified, the user created by the API is set to Active.

2309 - September Release

Available as of September 16, 2023

1. Backlink DMS Documents into DealCloud via API
   
   • The documentStorageID property can now be used to link documents from a Document Management System (DMS) such as Box or SharePoint to the Documents object in DealCloud. Updating the documentStorageID property with a document's DMS ID causes the entry title in DealCloud to link to the DMS document location.
   • See guide here

2308 - Summer Release

Available as of July 22, 2023

Schema API

1. Filter for Fields that are Editable & on Entry Forms
   Filter & identify fields that are present on entry forms and that are editable on the GET /[entryTypeId]/fields endpoint using the following two query parameters
   • editable - When set to true, only editable fields will be returned
   • entryForm - When set to true, only fields present on the entry form will return

User Management API

2. Add/Remove Users from Groups
   Two new endpoints allow administrators to quickly add or remove one or more users from one or more user groups. These endpoints append user group assignments (and not replace), making it easier to iteratively manage entitlements and roles.

   • To add users to user groups, use the PUT /api/rest/v1/management/user/group endpoint
   • To remove users from groups, use the DELETE /api/rest/v1/management/user/group endpoint

3. Retrieve Users by User Group ID
   A new optional query parameter called userGroupID has been added to the GET /user endpoint, which allows the API to retrieve a list of users using a user group ID. This enhancement provides a new way to retrieve lists of users so administrators can manage their roles, permissions, and user groups effectively.
   

4. User Invitation API
   A new API endpoint has been added to User Management - POST /user/invite - allowing users to be invited to a site through an API. The invitation can be set to either Permanent ("type": 0) or Temporary ("type": 1). If a temporary invitation is sent, a duration must also be set in days (e.g. "duration": 10).

5. Security Config Enhancements
   The User Management APIs can now be used to configure two-factor authentication and IP restrictions at the user level. This update allows administrators to automate the configuration of 2FA and IP restrictions via external systems and into DealCloud.

   • TwoFactorEnabled - When set to True, 2FA is enabled for the user. This cannot be disabled via the API.
   • IpRestrictionsEnabled - When set to True, the user's access is restricted to only whitelisted IP addresses. This cannot be disabled via the API.

2305 - Spring Release (Orion)

Available as of April 20, 2023

1. All History endpoint released, this allows you to get modified entries and releated entries modified
2. Show mergedEntryId in History and All History endpoints when a entry is deleted by merging
3. Schema Fields now allows you to filter for different field types, editable | calculated, as well as editable fields that are on the entry form.