The Bigin by Zoho CRM connector lets your AI agent act in each user's Bigin by Zoho CRM account. Each user signs in to Bigin by Zoho CRM once, and Scalekit stores and refreshes their tokens, so your agent never handles credentials. It comes with 21 tools.
- Tools
- 21
- What they doRead · write · destructive
- 12 · 7 · 212 read7 write2 destructive
- Users sign in with
- OAuth
- OAuth app
- Your own Bigin by Zoho CRM app
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Bigin by Zoho CRM connection
In AgentKit > Connections, create a Bigin by Zoho CRM connection and copy its redirect URI. The name you give it is the
connection_nameyour code passes. See Configure connections.Register an OAuth app
Bigin by Zoho CRM connections use your own OAuth app. Register one with Bigin by Zoho CRM and add the redirect URI you copied.
Then enter the app's Client ID and Client Secret on the Bigin by Zoho CRM connection.
Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'zohobigin'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Bigin by Zoho CRM:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'zohobigin_modules_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "zohobigin"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Bigin by Zoho CRM:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="zohobigin_modules_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user signs in once. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolzohobigin_custom_views_listList the custom views (saved filters) of a module.Read-onlyList Custom Views
List the custom views (saved filters) of a module. Returns custom_views[] with id, name, display_value and default flag. Use zohobigin_custom_views_list to get a cvid for zohobigin_records_list.
Inputs
modulestringrequired- API name of the module that holds the views: Contacts, Pipelines, Accounts, Products, Tasks, Events, Calls. Companies use Accounts; deals use Pipelines. Example: Contactsone of
ContactsPipelinesAccountsProductsTasksEventsCalls
zohobigin_fields_listList the fields of a module.Read-onlyList Fields
List the fields of a module. Returns fields[] with api_name, field_label, data_type, length, required/read-only flags and picklist values. Use zohobigin_fields_list to get field API names for fields, criteria and record data.
Inputs
modulestringrequired- API name of the module that holds the fields: Contacts, Pipelines, Accounts, Products, Tasks, Events, Calls. Companies use Accounts; deals use Pipelines. Example: Contactsone of
ContactsPipelinesAccountsProductsTasksEventsCalls
zohobigin_modules_listList the modules in the Bigin organization.Read-onlyList Modules
List the modules in the Bigin organization. Returns modules[] with api_name, module_name, singular and plural labels, and whether each module is API-supported. Use zohobigin_modules_list to find module API names. Use zohobigin_fields_list for a module's fields.
Inputs
This tool takes no inputs.
zohobigin_notes_listList the notes on a record.Read-onlyList Notes
List the notes on a record. Returns data[] of notes with id, Note_Title, Note_Content, Parent_Id and owner, plus paging info. Use zohobigin_notes_list to read a record's notes. Use zohobigin_note_create to add one.
Inputs
fieldsstringrequired- Comma-separated note fields to return. Example: Note_Title,Note_Content,Parent_Id
modulestringrequired- API name of the module that holds the records: Contacts, Pipelines, Accounts, Products. Companies use Accounts; deals use Pipelines. Example: Contactsone of
ContactsPipelinesAccountsProducts record_idstringrequired- ID of the record (from zohobigin_records_list or zohobigin_records_search). Example: 2034020000000489022
pageinteger- Page index, starting at 1. Example: 2
per_pageinteger- Records per page, up to 200 (the default). Example: 50
zohobigin_org_getGet the Bigin organization's details.Read-onlyGet Organization
Get the Bigin organization's details. Returns org[] with id, company_name, primary_email, currency, time_zone, country and license details. Use zohobigin_org_get to check which organization the connection is for.
Inputs
This tool takes no inputs.
zohobigin_record_getGet one record from a Bigin module with all of its fields.Read-onlyGet Record
Get one record from a Bigin module with all of its fields. Returns data[] with the single record: id, Owner, the module's fields, tags and timestamps. Use zohobigin_record_get when you know the record ID. Use zohobigin_records_list or zohobigin_records_search to find it.
Inputs
modulestringrequired- API name of the module that holds the records: Contacts, Pipelines, Accounts, Products, Tasks, Events, Calls. Companies use Accounts; deals use Pipelines. Example: Contactsone of
ContactsPipelinesAccountsProductsTasksEventsCalls record_idstringrequired- ID of the record (from zohobigin_records_list or zohobigin_records_search). Example: 2034020000000489022
zohobigin_records_listList records in a Bigin module (contacts, pipeline deals, companies, products, tasks, events or calls), with chosen fields, sorting, custom view and paging.Read-onlyList Records
List records in a Bigin module (contacts, pipeline deals, companies, products, tasks, events or calls), with chosen fields, sorting, custom view and paging. Returns data[] of records with id and the requested fields, plus info with page, per_page, count, more_records and next_page_token. Use zohobigin_records_list to browse a module. Use zohobigin_records_search to filter by criteria, email, phone or a word.
Inputs
fieldsstringrequired- Comma-separated field API names to return, up to 50 (see zohobigin_fields_list). Example: Last_Name,Email,Phone
modulestringrequired- API name of the module that holds the records: Contacts, Pipelines, Accounts, Products, Tasks, Events, Calls. Companies use Accounts; deals use Pipelines. Example: Contactsone of
ContactsPipelinesAccountsProductsTasksEventsCalls approvedstring- Approval state: true (default), false or both. Example: bothone of
truefalseboth cvidstring- Custom view ID to list records from (see zohobigin_custom_views_list). Example: 2034020000000087501
pageinteger- Page index, starting at 1. Example: 2
page_tokenstring- next_page_token from a previous response, to read past the first 2000 records. Example: cd2cb80b7af0973c8e00
per_pageinteger- Records per page, up to 200 (the default). Example: 50
sort_bystring- Field API name to sort by. Example: Modified_Time
sort_orderstring- asc or desc. Example: descone of
ascdesc
zohobigin_records_searchSearch a Bigin module by criteria, email, phone number or a word; give exactly one of them.Read-onlySearch Records
Search a Bigin module by criteria, email, phone number or a word; give exactly one of them. Returns data[] of matching records and info with paging details; an empty response (HTTP 204) means no match. Use zohobigin_records_search to find records by value. Use zohobigin_records_list to browse without a filter.
Inputs
modulestringrequired- API name of the module that holds the records: Contacts, Pipelines, Accounts, Products, Tasks, Events, Calls. Companies use Accounts; deals use Pipelines. Example: Contactsone of
ContactsPipelinesAccountsProductsTasksEventsCalls criteriastring- Criteria in the form (field_api_name:operator:value), combined with and/or. Operators include equals, starts_with, greater_than and less_than. Example: ((Last_Name:starts_with:B)and(Email:equals:ava.bell@example.com))
emailstring- Email address to match against all email fields. Example: ava.bell@example.com
phonestring- Phone number to match against all phone fields. Example: 98883434559
wordstring- Word to match across the module's text fields. Example: Acme
zohobigin_user_getGet one Bigin user.Read-onlyGet User
Get one Bigin user. Returns users[] with the user's id, full_name, email, role, profile, time zone and status. Use zohobigin_user_get with an ID from zohobigin_users_list.
Inputs
user_idstringrequired- ID of the user. Example: 2034020000000327001
zohobigin_users_listList users in the Bigin organization, filtered by type.Read-onlyList Users
List users in the Bigin organization, filtered by type. Returns users[] with id, full_name, email, role, profile and status, plus paging info. Use zohobigin_users_list to find an owner ID for records. Use zohobigin_user_get for one user.
Inputs
pageinteger- Page index, starting at 1. Example: 2
per_pageinteger- Records per page, up to 200 (the default). Example: 50
typestring- AllUsers, ActiveUsers, DeactiveUsers, ConfirmedUsers, NotConfirmedUsers or DeletedUsers. Example: ActiveUsersone of
AllUsersActiveUsersDeactiveUsersConfirmedUsersNotConfirmedUsersDeletedUsers
zohobigin_note_createAdd a note to a record.WriteCreate Note
Add a note to a record. Returns data[] with code, status and details.id of the new note. Use zohobigin_note_create to log information on a contact, deal, company or product.
Inputs
modulestringrequired- API name of the module that holds the records: Contacts, Pipelines, Accounts, Products. Companies use Accounts; deals use Pipelines. Example: Contactsone of
ContactsPipelinesAccountsProducts note_contentstringrequired- Note text. Example: Prefers a 3-week campaign starting 1 October
record_idstringrequired- ID of the record (from zohobigin_records_list or zohobigin_records_search). Example: 2034020000000489022
note_titlestring- Note title. Example: Preferred campaign duration
zohobigin_note_updateChange the title or content of a note on a record.WriteUpdate Note
Change the title or content of a note on a record. Returns data[] with code, status and details.id. Use zohobigin_note_update with a note ID from zohobigin_notes_list.
- Idempotent
Inputs
modulestringrequired- API name of the module that holds the records: Contacts, Pipelines, Accounts, Products. Companies use Accounts; deals use Pipelines. Example: Contactsone of
ContactsPipelinesAccountsProducts note_idstringrequired- ID of the note. Example: 2034020000000724056
record_idstringrequired- ID of the record (from zohobigin_records_list or zohobigin_records_search). Example: 2034020000000489022
note_contentstring- New note text. Example: 5th December 2026
note_titlestring- New note title. Example: Arrival date
zohobigin_record_updateUpdate fields on one record in a Bigin module.WriteUpdate Record
Update fields on one record in a Bigin module. Returns data[] with code, status and details (id, Modified_Time). Use zohobigin_record_update to change a record. Use zohobigin_records_create for new records.
- Idempotent
Inputs
fields_to_updateobjectrequired- Field API names and their new values. Lookups take {"id": "..."}. Example: {"Stage": "Qualification", "Amount": 8000}
modulestringrequired- API name of the module that holds the records: Contacts, Pipelines, Accounts, Products, Tasks, Events, Calls. Companies use Accounts; deals use Pipelines. Example: Contactsone of
ContactsPipelinesAccountsProductsTasksEventsCalls record_idstringrequired- ID of the record (from zohobigin_records_list or zohobigin_records_search). Example: 2034020000000489022
triggerarray- Automation to run: ["workflow"] runs workflow rules (the default when omitted); [] runs none. Example: []
zohobigin_records_createCreate one or more records (up to 100) in a Bigin module.WriteCreate Records
Create one or more records (up to 100) in a Bigin module. Returns data[] with each record's code, status and details.id. Use zohobigin_records_create for new records. Use zohobigin_records_upsert to update a record if a duplicate exists, or zohobigin_record_update to change one.
Inputs
dataarrayrequired- Records to create, each an object of field API names to values. Contacts need Last_Name; Accounts need Account_Name; Pipelines need Deal_Name, Sub_Pipeline and Stage. Lookups such as Owner or Account_Name take {"id": "..."}. Example: [{"Last_Name": "Bell", "First_Name": "Ava", "Email": "ava.bell@example.com"}]
modulestringrequired- API name of the module that holds the records: Contacts, Pipelines, Accounts, Products, Tasks, Events, Calls. Companies use Accounts; deals use Pipelines. Example: Contactsone of
ContactsPipelinesAccountsProductsTasksEventsCalls triggerarray- Automation to run: ["workflow"] runs workflow rules (the default when omitted); [] runs none. Example: []
zohobigin_records_upsertInsert records, or update the existing record when a duplicate is found on the duplicate-check fields.WriteUpsert Records
Insert records, or update the existing record when a duplicate is found on the duplicate-check fields. Returns data[] with each record's action (insert or update), code, status and details.id. Use zohobigin_records_upsert to sync records without creating duplicates. Use zohobigin_records_create to always insert.
Inputs
dataarrayrequired- Records, each an object of field API names to values. Example: [{"Last_Name": "Bell", "Email": "ava.bell@example.com", "Mobile": "5550101"}]
modulestringrequired- API name of the module that holds the records: Contacts, Pipelines, Accounts, Products, Tasks, Events, Calls. Companies use Accounts; deals use Pipelines. Example: Contactsone of
ContactsPipelinesAccountsProductsTasksEventsCalls duplicate_check_fieldsarray- Field API names used to find an existing record; defaults to the module's unique fields. Example: ["Email"]
triggerarray- Automation to run: ["workflow"] runs workflow rules (the default when omitted); [] runs none. Example: []
zohobigin_note_deleteDelete a note from a record.DestructiveDelete Note
Delete a note from a record. Returns data[] with code, status and details.id of the deleted note. Use zohobigin_note_delete with a note ID from zohobigin_notes_list.
- Idempotent
Inputs
modulestringrequired- API name of the module that holds the records: Contacts, Pipelines, Accounts, Products. Companies use Accounts; deals use Pipelines. Example: Contactsone of
ContactsPipelinesAccountsProducts note_idstringrequired- ID of the note to delete. Example: 2034020000000724056
record_idstringrequired- ID of the record (from zohobigin_records_list or zohobigin_records_search). Example: 2034020000000489022
zohobigin_record_deleteDelete one record from a Bigin module (it moves to the recycle bin).DestructiveDelete Record
Delete one record from a Bigin module (it moves to the recycle bin). Returns data[] with code, status and details.id of the deleted record. Use zohobigin_record_delete to remove a record; confirm the ID with zohobigin_record_get first.
- Idempotent
Inputs
modulestringrequired- API name of the module that holds the records: Contacts, Pipelines, Accounts, Products, Tasks, Events, Calls. Companies use Accounts; deals use Pipelines. Example: Contactsone of
ContactsPipelinesAccountsProductsTasksEventsCalls record_idstringrequired- ID of the record (from zohobigin_records_list or zohobigin_records_search). Example: 2034020000000489022
wf_triggerboolean- Run workflow rules on delete (default true). Example: false
No tools match.