Skip to navigation

Zoho Bigin

Connect your AI agents to Zoho Bigin

Authentication: OAuth. When connecting, select the data center your Bigin account is hosted in, such as bigin.zoho.eu for Europe. Canada is not supported. See Magic Link for the runtime auth flow, or Application credentials to bring your own OAuth app.

Sample use cases

  • Find contacts by email and review their pipeline deals before a sales call
  • Create a follow-up task and attach a note to a contact record
  • Export records with a bulk read job for a sales report

Available tools

add_tags

Tag 1-100 Bigin records with one or more tag names (a name that does not exist is created).

change_records_owner

Reassign 1-500 records in a Bigin module to another user, optionally with their open Tasks/Events/Calls and an email to the new owner.

count_records

Count records in a Bigin module, optionally only those matching a search criteria, email, phone, keyword or custom view.

count_tag_records

Count the records in a Bigin module that carry a tag. Find the tag ID with list_tags.

create_bulk_read_job

Start an asynchronous export of up to 200,000 records from a Bigin module to CSV (or ICS for Events), optionally filtered by criteria or a custom view.

create_notes

Add 1-100 notes, each to a Bigin record named by its module and ID (contact, deal, company, product, task, event or call).

create_records

Create 1-100 records in a Bigin module. Returns each row’s new record ID, or the failing field.

create_tags

Create tags in a Bigin module, each with a name and optional color.

delete_attachment

Delete a file or link attached to a Bigin record. Find the attachment ID with list_attachments.

delete_notes

Delete 1-100 Bigin notes by ID. Find note IDs with list_record_notes or list_notes.

delete_record_photo

Remove the profile photo of a Bigin contact, company or product. Inverse of upload_record_photo.

delete_records

Delete 1-100 records from a Bigin module by ID.

delete_tag

Delete a tag from Bigin; it is removed from every record that had it. Find the tag ID with list_tags.

delink_related_records

Unlink 1-100 related records from a Bigin record (e.g.

download_attachment

Download a file attached to a Bigin record through the platform’s file transfer (no bytes in the reply).

download_bulk_read_result

Download a completed Bigin bulk read job’s export (a zip holding one CSV, or ICS for Events) through the platform’s file transfer (no bytes in the reply).

download_file

Download a file from Bigin’s file store by the file ID upload_file returned, through the platform’s file transfer (no bytes in the reply).

download_record_photo

Download the profile photo of a Bigin contact, company or product through the platform’s file transfer (no bytes in the reply).

get_bulk_read_job

Check a Bigin bulk read (export) job: its state (ADDED, IN PROGRESS, COMPLETED, FAILURE), the record count, and whether more records need another job (page+1).

get_custom_view

Get one Bigin custom view: its filter criteria, columns and sort. Find view IDs with list_custom_views.

get_module

Get one Bigin module’s settings: labels, permissions, views and lookup properties.

get_organization

Get the connected Bigin organization’s details: company name, domain, time zone, currency, country and plan.

get_record

Get one Bigin record by module and ID, with every field; name fields to cut the payload on wide custom modules.

get_user

Get one Bigin user by ID: name, email, status, role, profile and time zone. Find user IDs with list_users.

list_attachments

List the files and links attached to a Bigin record (contact, deal, company, product, task or event): ID, name, size, owner.

list_contact_pipeline_records

List the deals (pipeline records) a Bigin contact is associated with, including the contact’s role on each (Bigin always returns Contact_Role).

list_custom_views

List a Bigin module’s custom views (saved filters such as ‘New Last Week’ or ‘My Contacts’) with IDs.

list_deleted_records

List records deleted from a Bigin module: in the recycle bin (60 days) or permanently deleted.

list_fields

List a Bigin module’s fields: API names, types, which are mandatory or read-only, lookup targets and picklist values.

list_from_addresses

List the email addresses the connected Bigin user may send from (their own and any organization addresses).

list_layouts

List a Bigin module’s layouts.

list_modules

List the modules in the Bigin organization (Contacts, Pipelines, Accounts, Products, Tasks, Events, Calls and custom modules) with their API names and permissions.

list_notes

List notes across every Bigin record, newest or oldest first, with paging.

list_pipeline_records

List the deal records in one Bigin team pipeline, with field selection, sort and paging.

list_profiles

List the permission profiles in the Bigin organization (e.g.

list_record_notes

List the notes on one Bigin record (contact, deal, company, product, task or event).

list_records

List records in a Bigin module (Contacts, Pipelines=deals, Accounts=companies, Products, Tasks, Events, Calls, or a custom module) with field selection, sort, custom-view filter and paging.

list_related_lists

List the related lists of a Bigin module (e.g.

list_related_records

List records in one related list of a Bigin record, e.g.

list_roles

List the roles in the Bigin organization and the hierarchy between them (reporting_to).

list_tags

List the tags defined for a Bigin module (Contacts, Pipelines, Accounts, Products, Tasks, Events, Calls), with IDs and colors.

list_users

List Bigin users (all, active, admins, or just the connected user with type ‘CurrentUser’), with IDs, roles and profiles.

query_records

Run a read-only COQL SELECT across a Bigin module: filter on any fields with =, !=, like, in, between, is null, sort with ORDER BY, page with LIMIT (max 200) and OFFSET.

read_attachment_text

Read the text of a PDF, DOCX, XLSX or plain-text file attached to a Bigin record.

remove_tags

Remove one or more tags (by name) from 1-100 Bigin records.

search_records

Search a Bigin module by criteria (field:operator:value), email, phone, or keyword (exactly one).

send_email

Send an email from a Bigin record (contact, deal, company) so it is logged on that record.

update_note

Change a Bigin note’s title or text. Needs the note ID and its parent record (module and ID), from list_record_notes or list_notes (Parent_Id).

update_records

Update 1-100 existing records in a Bigin module.

update_related_records

Link 1-100 records to a Bigin record through a related list, or update the relation’s fields (e.g.

update_tags

Rename or recolor tags in a Bigin module.

upload_attachment

Attach a file (file_reference staged through the platform’s file endpoint, max 20 MB) or a web link (link_url) to a Bigin record.

upload_file

Upload a file (staged through the platform’s file endpoint, max 20 MB) to Bigin’s file store and get its file ID, for use as an email attachment in send_email (attachment_file_ids).

upload_record_photo

Set the profile photo of a Bigin contact, company or product from an image staged through the platform’s file endpoint (max 10 MB, 10 megapixels).

upsert_records

Create or update 1-100 records: a record matching an existing one on duplicate_check_fields (e.g.

create_users

Invite one user to Bigin; consumes a user license and sends an invitation email.

delete_user

Delete one Bigin user from the organization by user_id from list_users/get_user.

disable_notifications

Delete Bigin notification channels and stop all their events.

enable_notifications

Enable Bigin webhook channels for record events, up to 100 channels per call.

list_notifications

List active Bigin notification subscriptions with channel IDs, events, expiry and callback URL.

patch_notifications

Partially update up to 100 Bigin notification channels, keeping omitted details.

update_notifications

Replace details of up to 100 Bigin notification channels via PUT.

update_tag

Rename or recolor one tag through its tag-specific endpoint.

update_user

Update one Bigin user through their user-specific endpoint.

update_users

Update multiple Bigin users by ID, including role, profile or active/inactive status.