What's New in V4?
New APIs
Mass Change Owner
You can now change the owner of the records of a module in a particular custom view and territory for up to 50,000 records through this API. This API schedules a job in the background.
Use the Get Mass Change Owner Status API to find out the status of the job such as the total number of records you scheduled the job for, the number of records whose owners have been changed, the number that failed etc,.
Mass Delete
Delete up to 50,000 records in a custom view or up to 500 records using their record IDs through this API, and get the status and details such as the number of records scheduled, the number deleted, the number failed etc,.
Mass Convert Lead
You can now convert up to 50 leads in a single request through this API. this API also allows you to create or not create a deal while converting and also handle the mandatory fields in the layout while converting the lead. Since this API also deals with many records, it schedules a job in the background.
Use the Get Mass Convert Status API to get the details of the number of records that were converted, the number that failed etc,.
User Groups
You can create different types of groups (set of users) to manage a set of common records. Users associated with a particular group can access the records shared to a particular group and perform the necessary operations on the records. Use the below APIs in this version to:
- Get all user groups in your org.
- Get sources count to get the number of users, groups, roles, and territories available in a user group.
- Get sources by type to get the details of a member of a user group by the type.
- Create a user group.
- Update a user group.
- Delete a user group.
Portals
You can now
- Get the portals available for your org
- Create and update a portal
- Create, update, get, and delete user type for each portal
- Get users of a user type
- Invite a user to a portal
- Transfer users from a user type to another
- Change a user's status
- Delete a user from the portal
Emails
You can now
- Get emails of a record
- Get email's sharing details
- Download the attachments in an email
- Download the inline images in an email
- Associate an email with a record
Profiles
From this version, you can create, update, and transfer users and delete a profile from your org.
Field Map Dependency
There are certain fields in a module whose values depend on another field's value. This can be defined as a parent-child relationship. For example, let's say there are two fields - Country and State - in your Leads module. The values in the State field will depend on the country that you select from the Country field. In Zoho CRM, you can define the values that are applicable to a child field based on the parent field's value. This is called mapping dependency fields.
You can now map the picklist values of the dependent field of a child with those of the parent's, via API. You can also get the details of the mapped dependency field, update the picklist values of the child, and delete the dependency, altogether.
Updates to the Existing APIs
The following are the major updates:
- Query API
- You can now query up to 2000 records per API call using this API(you can fetch only 200 records per API call in V3).
- The select query supports the aggregate functions SUM(), MAX(), MIN(), AVG(), and COUNT().
- You can query for records using the external fields and their values.
- Composite API
- This API consumes only one API credit even when all the sub-requests are successful(as opposed to two credits in V3)
The following APIs have updates. Refer to the Change log for more details and the differences between the versions 3 and 4.