API Methods

API Methods

Method Name
Purpose
getRecords
To retrieve all users data specified in the API request
getRecordById
To retrieve individual records by record ID
addRecords
To insert records into the required Zoho Recruit module
updateRecords
To update or modify the records in Zoho Recruit

getNoteTypes

To retrieve all note types in the user account which will be useful while adding Notes through API
getRelatedRecords
To retrieve records related to a primary module
getFields
To retrieve details of fields available in a module

getAssociatedJobOpenings

To retrieve Associated JobOpenings of a given Candidate

changeStatus

To change the candidate status with respect to the job openings in Zoho Recruit

changeCandidateRating
To change the candidate rating with respect to the job openings in Zoho Recruit
uploadFile
To attach a file to a record
downloadFile
To download a file attached to a record

associateJobOpening

To associate candidates to job openings in Zoho Recruit
uploadPhoto
To add a photo to a contact or candidate
downloadPhoto
To download the photo of a contact or candidate

uploadDocument

To parse and upload candidate resumes from third-party applications. This is available only in the Paid Edition.
getModules
To retrieve all modules from Zoho Recruit account

getAssociatedCandidates

To get associated Candidates for a Job Opening

getSearchRecords

To search records by the expressions of the selected columns

To get tabular data for a specified record
To add tabular data for a specified record
To update particular tabular entries for a specified record
deleteTabularRecords
To delete tabular entries for a specified record

    • Related Articles

    • What is the format of the xmlData parameter for the insertRecords and updateRecords methods?

      Use the following XMLData parameters while using insertRecords and updateRecords methods: insertRecords: https:// crm.zoho.com/crm/private/ xml / Leads /insertRecords?apikey= API Key &ticket= Ticket ticket=xxxxxxxxxxxxxx apikey=xxxxxxxxxxxxxx ...

    • Orchestly API guide

      Orchestly’s  REST APIs allow users to build applications or develop integrations between Orchestly and other applications. The  OAuth 2.0 protocol used in Orchestly handles the authentication and authorization processes.   Here are the basic steps ...

    • Using Gmail API

      Zoho CRM provides a variety of emailing options that users can choose based on their requirements. One such option is the Zoho Mail Add-on. With Zoho Mail Add-on, you can configure your email client within Zoho CRM using either one of the two ...

    • What will happen if my API limit has been exceeded for the day?

      If your API limit has been exceeded for the day, Zoho CRM will not respond to the API calls for the rest of the day. You need to wait till the API limit is reset for the next day. API limits are reset everyday between 12 am and 3 am PST. If the ...

    • App assignment methods

      Apps can be assigned to users by four different methods: Assign to individual user: The admin can assign the app to every user individually. Assign to a group: The admin can assign the app to all the users in a group or department. Assign to ...