What's New in V3?

New APIs

Composite API

The composite API allows you to combine up to five API calls in a single request consuming just one or two credits per composite call. This API reduces the round-trip time and allows you to execute the APIs in a single database transaction, if needed.

What is Round-trip time (RTT) and how does this API reduce it? The time taken for the request to reach the server and render a response is called the Round-trip time.
Since you club all the requests in a composite API, round-trip time is saved. This API can also execute the independent requests in parallel while simultaneously executing the dependent requests.
Should one or more of the sub-requests fail, you can choose to rollback (revert all the changes) the entire transaction.

Let us discuss the two scenarios in which this API is at its best.

  1. Sub-requests are not executed under the same transaction (rollback is not performed)
    1. a. Independent APIs (requests are served concurrently)
      Consider that you want to fetch the metadata of the Leads module, its layouts, fields, and custom views. Instead of making four individual API calls and losing four credits, you can use the composite API for just one credit. On our server side, we will process the API calls in parallel.

    2. b. With dependent sub-requests (requests are served sequentially)
      Consider a use case where you update a contact's Lead Source to Employee Referral in a sub-request. In sub-request 2, you insert a lead that triggers a workflow when the related contact's lead source is employee referral.
      In parallel execution, we cannot guarantee that sub-request 1 is served first followed by sub-request 2. So, the workflow might not be updated in sub-request 2 as the criteria will not be met before serving sub-request 1. In this case, sequential execution is the way to go.

  2. Sub Requests are executed under the same transaction (rollback can be performed)
    This flow is useful when your custom business logic is complex and demands multiple operations in a single transaction. Consider an example where you want to close a deal, create a quote for that deal, and add a tag to that quote.
    This composite API call consumes just two credits on successful execution, while it consumes one credit when a rollback is performed.

Change Owner API

You can now change the owner of a record or multiple records, and also assign the related records to the new owner through this API.

Scoring Rules APIs

Scoring Rules allow you to spot the most valuable records that fit your criteria.
Now, with these APIs, you can:

Lead Conversion Options

Use this API before converting a lead to get the ddetials of the matching records in Deals, Accounts, and Contacts, to avoid duplicity and errors while converting.

Territories of a User as a Related List

Use these APIs to:

Updates to the Existing APIs

The following APIs have updates. Refer to the Change log for more details and the differences between the versions 2.1 and 3.