Sample Codes

All of Zoho CRM's APIs can be used through the Java SDK, to enable your custom application to perform data sync to the best degree. Here are the sample codes for all the API methods available in our SDK.

Attachment Operations

Constructor	Description
AttachmentsOperations(String moduleAPIName, String recordId)	Creates an AttachmentsOperations class instance with the moduleAPIName and recordId.

Method	Return Type	Description
getAttachments	APIResponse<ResponseHandler>	To fetch the list of attachments of a record.
uploadAttachments	APIResponse<ActionHandler>	To upload attachments to a record.
deleteAttachments	APIResponse<ActionHandler>	To delete the attachments that were added to a record.
deleteAttachment	APIResponse<ActionHandler>	To delete an attachment that was added to a record.
downloadAttachment	APIResponse<ResponseHandler>	To download an attachment that was uploaded to a record.
uploadLinkAttachments	APIResponse<ActionHandler>	To upload a link as an attachment to a record.

Blueprint Operations

Constructor	Description
BluePrintOperations(String recordId, String moduleAPIName)	Creates a BluePrintOperations class instance with the recordId and moduleAPIName.

Method	Return Type	Description
getBlueprint	APIResponse<ResponseHandler>	To get the next available transitions for that record, fields available for each transition, current value of each field, and validation(if any).
updateBlueprint	APIResponse<ActionResponse>	To update a single transition at a time.

Bulk Read Operations

Method	Return Type	Description
createBulkReadJob	APIResponse<ActionHandler>	To schedule a bulk read job to export records that match the criteria.
getBulkReadJobDetails	APIResponse<ResponseHandler>	To know the status of the bulk read job scheduled previously.
downloadResult	APIResponse<ResponseHandler>	To download the result of the bulk read job. The response contains a zip file. Extract it to get the CSV or ICS file depending on the "file_type" you specified while creating the bulk read job

Bulk Write Operations

Method	Return Type	Description
uploadFile	APIResponse<ActionResponse>	To upload a CSV file in ZIP format. The response contains the "file_id". Use this ID while making the bulk write request.
createBulkWriteJob	APIResponse<ActionResponse>	To create a bulk write job to insert, update, or upsert records. The response contains the "job_id". Use this ID while getting the status of the scheduled bulk write job.
getBulkReadJobDetails	APIResponse<ResponseWrapper>	To know the status of the bulk read job scheduled previously.
downloadResult	APIResponse<ResponseHandler>	To download the result of the bulk read job. The response contains a zip file. Extract it to get the CSV or ICS file depending on the "file_type" you specified while creating the bulk read job

Contact Roles Operations

Method	Return Type	Description
getContactRoles	APIResponse<ResponseHandler>	To get the list of all contact roles.
createContactRoles	APIResponse<ActionHandler>	To create contact roles.
updateContactRoles	APIResponse<ActionHandler>	To update contact roles.
deleteContactRoles	APIResponse<ActionHandler>	To delete contact roles.
getContactRole	APIResponse<ResponseHandler>	To get specific contact role.
updateContactRole	APIResponse<ActionHandler>	To update specific contact role.
deleteContactRole	APIResponse<ActionHandler>	To delete specific contact role.
getAllContactRolesOfADeal	APIResponse<ActionHandler>	This method is used to get all Contact Roles of deal and print the response.
getContactRolesOfDeal	APIResponse<ResponseHandler>	This method is used to get Contact Roles of deal and print the response.
addContactRolesToDeal	APIResponse<ActionHandler>	This method is used to add Contact Role to deal and print the response.
remContactRolesDeal	APIResponse<ActionHandler>	This method is used to remove Contact Roles from deal and print the response.

Currencies Operations

Method	Return Type	Description
getCurrencies	APIResponse<ResponseHandler>	To get the list of all currencies available for your org.
addCurrencies	APIResponse<ActionHandler>	To add new currencies to your org.
updateCurrencies	APIResponse<ActionHandler>	To update the currencies' details of your org.
enableMultipleCurrencies	APIResponse<BaseCurrencyAction Handler>	To enable multiple currencies for your org.
updateBaseCurrency	APIResponse<BaseCurrencyAction Handler>	To update the base currency details of your org.
getCurrency	APIResponse<ResponseHandler>	To get the details of specific currency.
updateCurrency	APIResponse<ActionHandler>	To update the details of specific currency.

Custom View Operations

Constructor	Description
CustomViewsOperations(String module)	Creates a CustomViewsOperations class instance with the moduleAPIName.

Method	Return Type	Description
getCustomViews	APIResponse<ResponseHandler>	To get the list of all custom views in a module.
getCustomView	APIResponse<ResponseHandler>	To get the details of specific custom view in a module.

Fields Metadata Operations

Constructor	Description
FieldsOperations(String module)	Creates a FieldsOperations class instance with the module.

Method	Return Type	Description
getFields	APIResponse<ResponseHandler>	To get the meta details of all fields in a module.
getField	APIResponse<ResponseHandler>	To get the meta details of specific field in a module.

Files Operations

Method	Return Type	Description
uploadFiles	APIResponse<ActionHandler>	To upload files and get their encrypted IDs.
getFile	APIResponse<ResponseHandler>	To get the uploaded file through its encrypted ID.

Layouts Operations

Constructor	Description
LayoutsOperations(String module)	Creates a LayoutsOperations class instance with the moduleAPIName.

Method	Return Type	Description
getLayouts	APIResponse<ResponseHandler>	To get the details of all the layouts in a module.
getLayout	APIResponse<ResponseHandler>	To get the details (metadata) of a specific layout in a module.

Modules Operations

Method	Return Type	Description
getModules	APIResponse<ResponseHandler>	To get the details of all the modules.
getModule	APIResponse<ResponseHandler>	To get the details (metadata) of a specific module.
updateModuleByAPIName	APIResponse<ActionHandler>	To update the details of a module by its module API name.
updateModuleById	APIResponse<ActionHandler>	To update the details of a module by its ID.

Notes Operations

Method	Return Type	Description
getNotes	APIResponse<ResponseHandler>	To get the list of notes of a record.
createNotes	APIResponse<ActionHandler>	To add new notes to a record.
updateNotes	APIResponse<ActionHandler>	To update the details of the notes of a record.
deleteNotes	APIResponse<ActionHandler>	To delete the notes of a record.
getNote	APIResponse<ResponseHandler>	To get the details of a specific note.
updateNote	APIResponse<ActionHandler>	To update the details of an existing note.
deleteNote	APIResponse<ActionHandler>	To delete a specific note.

Notification Operations

Method	Return Type	Description
enableNotifications	APIResponse<ActionHandler>	To enable instant notifications of actions performed on a module.
getNotificationDetails	APIResponse<ResponseHandler>	To get the details of the notifications enabled by the user.
updateNotifications	APIResponse<ActionHandler>	To update the details of the notifications enabled by a user. All the provided details would be persisted and rest of the details would be removed.
updateNotification	APIResponse<ActionHandler>	To update only specific details of a specific notification enabled by the user. All the provided details would be persisted and rest of the details will not be removed.
disableNotifications	APIResponse<ActionHandler>	To stop all the instant notifications enabled by the user for a channel.
disableNotification	APIResponse<ActionHandler>	To disable notifications for the specified events in a channel.

Organization Operations

Method	Return Type	Description
getOrganization	APIResponse<ResponseHandler>	To get the details of your organization.
uploadOrganizationPhoto	APIResponse<ActionHandler>	To upload a photo of your organization.

Profile Operations

Constructor	Description
ProfilesOperations(OffsetDateTime ifModifiedSince)	Creates a ProfilesOperations class instance with the value of the If-Modified-Since header.

Method	Return Type	Description
getProfiles	APIResponse<ResponseHandler>	To get the list of profiles available for your organization.
getProfile	APIResponse<ResponseHandler>	To get the details of a specific profile.

Query (COQL) Operation

Method	Return Type	Description
getRecords	APIResponse<ResponseHandler>	To get the records from a module through a COQL query.

Records Operations

Method	Return Type	Description
getRecord	APIResponse<ResponseHandler>	To get a specific record from a module.
updateRecord	APIResponse<ActionHandler>	To update a specific record in a module.
deleteRecord	APIResponse<ActionHandler>	To delete a specific record from a module.
getRecords	APIResponse<ResponseHandler>	To get all records from a module.
createRecords	APIResponse<ActioneHandler>	To insert records in a module.
updateRecords	APIResponse<ActionHandler>	To update records in a module.
deleteRecords	APIResponse<ActionHandler>	To delete records from a module.
upsertRecords	APIResponse<ActionHandler>	To insert/update records in a module.
getDeletedRecords	APIResponse<DeletedRecords Handler>	To get the deleted records from a module.
searchRecords	APIResponse<ActionHandler>	To search for records in a module that match certain criteria, email, phone number, or a word.
convertLead	APIResponse<ConvertActionHandler>	To convert records(Leads to Contacts/Deals).
getPhoto	APIResponse<DownloadHandler>	To get the photo of a record.
uploadPhoto	APIResponse<FileHandler>	To upload a photo to a record.
deletePhoto	APIResponse<FileHandler>	To delete the photo of a record.
massUpdateRecords	APIResponse<MassUpdateAction Handler>	To update the same field for multiple records in a module.
getMassUpdateStatus	APIResponse<MassUpdateAction Handler>	To get the status of the mass update job scheduled previously.

Related List Operations

Constructor	Description
RelatedListsOperations(String module)	Creates a RelatedListsOperations class instance with the moduleAPIName.

Method	Return Type	Description
getRelatedLists	APIResponse<ResponseHandler>	To get the details of all the related lists of a module.
getRelatedList	APIResponse<ResponseHandler>	To get the details of a specific related list of a module.

Related Records Operations

Constructor	Description
RelatedRecordsOperations(String relatedListAPIName, Long recordId, String moduleAPIName)	Creates a RelatedRecordsOperations class instance with the relatedListAPIName, recordId, and moduleAPIName.

Method	Return Type	Description
getRelatedRecords	APIResponse<ResponseHandler>	To get list of records from the related list of a module.
updateRelatedRecords	APIResponse<ActionHandler>	To update the association/relation between the records.
delinkRecords	APIResponse<ActionHandler>	To delete the association between the records.
getRelatedRecord	APIResponse<ResponseHandler>	To get the records from a specific related list of a module.
updateRelatedRecord	APIResponse<ActionHandler>	To update the details of a specific record of a related list in a module.
delinkRecord	APIResponse<ActionHandler>	To delete a specific record from the related list of a module.
getRelatedRecordsUsingExternalId	APIResponse<ActionHandler>	This method is used to get the related list records and print the response.
updateRelatedRecordsUsingExternalId	APIResponse<ResponseHandler>	This method is used to update the relation between the records and print the response.
deleteRelatedRecordsUsingExternalId	APIResponse<ActionHandler>	This method is used to delete the association between modules and print the response.
getRelatedRecordUsingExternalId	APIResponse<ActionHandler>	This method is used to get the single related list record and print the response

Role Operations

Method	Return Type	Description
getRoles	APIResponse<ResponseHandler>	To get the list of all roles available in your organization.
getRole	APIResponse<ResponseHandler>	To get the details of a specific role.

Shared Records Operations

Constructor	Description
ShareRecordsOperations(Long recordId, String moduleAPIName)	Creates a ShareRecordsOperations class instance with the recordId and moduleAPIName.

Method	Return Type	Description
getSharedRecordDetails	APIResponse<ResponseHandler>	To get the details of a record shared with other users.
shareRecord	APIResponse<ActionHandler>	To share a record with other users in the organization.
updateSharePermissions	APIResponse<ActionHandler>	To Update the sharing permissions of a record granted to users as Read-Write, Read-only, or grant full access. Revoke access given to users to a shared record. Update the access permission to the related lists of the record that was shared with the user.
revokeSharedRecord	APIResponse<DeleteActionHandler>	To revoke access to a shared record.

Tags Operations

Method	Return Type	Description
getTags	APIResponse<ResponseHandler>	To get the list of all tags in your organization.
createTags	APIResponse<ActionHandler>	To create tags.
updateTags	APIResponse<ActionHandler>	To update multiple tags.
updateTag	APIResponse<ActionHandler>	To update a specific tag.
deleteTag	APIResponse<ActionHandler>	To delete a specific tag from the module.
mergeTags	APIResponse<ActionHandler>	To merge two tags.
addTagsToRecord	APIResponse<RecordActionHandler>	To add tags to a specific record.
removeTagsFromRecord	APIResponse<RecordActionHandler>	To remove tags from a record.
addTagsToMultipleRecords	APIResponse<RecordActionHandler>	To add tags to multiple records.
removeTagsFromMultipleRecords	APIResponse<RecordActionHandler>	To remove tags from multiple records.
getRecordCountForTag	APIResponse<RecordActionHandler>	To get the record count for a tag.

Taxes Operations

Method	Return Type	Description
getTaxes	APIResponse<ResponseHandler>	To get the taxes of your organization.
createTaxes	APIResponse<ActionHandler>	To add taxes to your organization.
updateTaxes	APIResponse<ActionHandler>	To update the existing taxes of your organization.
deleteTaxes	APIResponse<ActionHandler>	To delete multiple taxes from your organization.
getTax	APIResponse<ResponseHandler>	To get the details of a specific tax.
deleteTax	APIResponse<ActionHandler>	To delete a specific tax from your organization.

Territory Operations

Method	Return Type	Description
getTerritories	APIResponse<ResponseHandler>	To get the list of all territories.
getTerritory	APIResponse<ResponseHandler>	To get the details of a specific territory.

Users Operations

Method	Return Type	Description
getUsers	APIResponse<ResponseHandler>	To get the list of users in your organization.
createUser	APIResponse<ActionHandler>	To add a user to your organization.
updateUsers	APIResponse<ActionHandler>	To update the existing users of your organization.
getUser	APIResponse<ResponseHandler>	To get the details of a specific user.
updateUser	APIResponse<ActionHandler>	To update the details of a specific user.
deleteUser	APIResponse<ActionHandler>	To delete a specific user from your organization.

Variable Groups Operations

Method	Return Type	Description
getVariableGroups	APIResponse<ResponseHandler>	To get the list of all variable groups available for your organization.
getVariableGroupById	APIResponse<ResponseHandler>	To get the details of a variable group by its group ID.
getVariableGroupByAPIName	APIResponse<ResponseHandler>	To get the details of a specific variable group by its API name.

Variables Operations

Method	Return Type	Description
getVariables	APIResponse<ResponseHandler>	To get the list of variables available for your organization.
createVariables	APIResponse<ActionHandler>	To add new variables to your organization.
updateVariables	APIResponse<ActionHandler>	To update the details of variables.
deleteVariables	APIResponse<ActionHandler>	To delete multiple variables.
getVariableById	APIResponse<ResponseHandler>	To get the details of a specific variable by its unique ID.
updateVariableById	APIResponse<ActionHandler>	To update the details of a specific variable by its unique ID.
deleteVariable	APIResponse<ActionHandler>	To delete a specific variable.
getVariableForAPIName	APIResponse<ResponseHandler>	To get the details of a variable by its API name.
updateVariableByAPIName	APIResponse<ActionHandler>	To update the details of a variable by its API name.