Dealcloud Release Notes

Site-Specific Publication API Endpoints

⚠️
Integration updates required to Publication APIs

The Publication API endpoints are now site-specific, replacing the previous environment/region-based endpoint structure. The new endpoints are also available on the standard site Swagger page. Integrations & requests should be updated to the site-specific endpoints. Legacy environment-based endpoints will continue to function temporarily, but clients should migrate to the new site-specific domains as soon as possible.

Template Report APIs

Three new endpoints have been added to the DealCloud REST API which allow administrators to programmatically generate template reports, allowing for more robust workflow automation. These endpoints allow you to identify existing template reports, initiate the generation of a report using a template, check the status of generation, and download the completed report

Release Notes

• 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.

• 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.

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 following endpoint:

PUT /api/rest/v1/management/user/group

• To remove users from groups, use the following endpoint:

DELETE /api/rest/v1/management/user/group

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.

Case Sensitive Tracking for API Updates

The REST API now tracks case changes to text fields. Previously, updating a field from "Example Company" to "EXAMPLE COMPANY" would not register as a change, causing issues for field updates that rely on precise casing such as brand names, codes, identifiers, and proper nouns.

With this update, case changes sent by the API are tracked and reflected in the product, matching the experience of entry form updates.

Warning When Disabling API key

If a user attempts to toggle off the Enable API Key option in their User Profile while the API key is already enabled, a new warning message now appears to inform them that doing so will break all active API connections using those credentials. It also clarifies that the same API key cannot be re-enabled, so any active integrations would need to be manually updated with a new key. This confirmation step is intended to prevent accidental downtime by ensuring that disabling an API key is an intentional decision.