# Zoho Bigin Your Toolhouse AI Worker can connect to Zoho Bigin using 54 specialized tools. {% hint style="info" %} This service requires an auth connection to use its tools. You can set this up in your Toolhouse dashboard under [Auth Connections](https://toolhouse.app/auth-connections?authkit_slugs=zoho_bigin). {% endhint %} ## Tools (54) ### `Zoho Bigin Add Records` Integration name: **ZOHO\_BIGIN\_ADD\_RECORDS** Tool to add new records to a module. Use when you need to programmatically insert one or more records into Bigin after confirming module name and field API names. Module-specific mandatory fields: - Tasks: Subject (required) - Events: Event\_Title, Start\_DateTime, End\_DateTime (all required) - Calls: Subject, Call\_Type (Outbound/Inbound/Missed), Call\_Start\_Time, Call\_Duration (all required) - Contacts: Last\_Name (required) - Other modules: Use Get Fields action to discover mandatory fields #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ----------------- | ------ | :------: | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `data` | array | ✅ | — | List of JSON objects to insert. Each object maps Field API names to values. Max 100 records per call. Module-specific mandatory fields: Tasks requires 'Subject'; Events requires 'Event\_Title', 'Start\_DateTime', 'End\_DateTime'; Calls requires 'Subject', 'Call\_Type' (Outbound/Inbound/Missed), 'Call\_Start\_Time', 'Call\_Duration'; Contacts requires 'Last\_Name'; Other modules may have their own requirements (use Get Fields action to discover). | | `trigger` | array | | `[]` | Array of workflow triggers. Default \['workflow'] executes workflows; use \[] to skip workflows. | | `module_api_name` | string | ✅ | `"Contacts"` | The API name of the module to insert into. Allowed: Contacts, Pipelines, Accounts, Products, Tasks, Events, Calls | *** ### `Zoho Bigin Add Tags To Records` Integration name: **ZOHO\_BIGIN\_ADD\_TAGS\_TO\_RECORDS** Tool to add tags to a specific record in a module. Use when you need to categorize or label a record after creation or update. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ----------------- | ------- | :------: | ------- | ----------------------------------------------------------- | | `tags` | array | ✅ | — | List of tag objects to add to the record | | `record_id` | string | ✅ | — | Unique identifier of the record to which tags will be added | | `over_write` | boolean | | `true` | Whether to overwrite existing tags (default: false) | | `module_api_name` | string | ✅ | — | API name of the module where record resides | *** ### `Zoho Bigin Create Bulk Read Job` Integration name: **ZOHO\_BIGIN\_CREATE\_BULK\_READ\_JOB** Tool to create a bulk read job for exporting large amounts of data asynchronously. Use when you need to export records from a module that may exceed standard API limits. Returns a job ID that can be used to track progress and download results once complete. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ---------- | ------ | :------: | ------- | ----------------------------------------------------------------------------------- | | `query` | object | ✅ | — | Query configuration specifying the module and optional filters for the bulk export. | | `callback` | object | | — | Callback configuration for job completion notification. | *** ### `Zoho Bigin Create Notes` Integration name: **ZOHO\_BIGIN\_CREATE\_NOTES** Tool to create notes and associate them with records in Zoho Bigin. Use when you need to add notes to contacts, accounts, pipelines, or other module records. Each note requires content, parent record ID, and the module name. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | --------- | ----- | :------: | ------- | ------------------------------------------------------------------------------------------- | | `data` | array | ✅ | — | Array of note objects to create. Each note must specify content, parent record, and module. | *** ### `Zoho Bigin Create Record Notes` Integration name: **ZOHO\_BIGIN\_CREATE\_RECORD\_NOTES** Tool to create new notes for a specific record. Use when you need to add notes to a Bigin record after confirming the module name and record ID. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ----------------- | ------ | :------: | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | | `data` | array | ✅ | `[{"Note_Title":"Test Note","Note_Content":"This is a test note created via API."}]` | List of note objects to create. Each note must have Note\_Content; Note\_Title is optional. | | `record_id` | string | ✅ | `"6796595000000648013"` | Unique identifier of the record to add notes to. | | `module_api_name` | string | ✅ | `"Contacts"` | API name of the module. Must be one of: Contacts, Pipelines, Accounts, Products, Tasks, Events, Calls. | *** ### `Zoho Bigin Create Tags` Integration name: **ZOHO\_BIGIN\_CREATE\_TAGS** Tool to create tags for a module. Use when you need to add new tags to a specific module in Zoho Bigin. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | --------- | ------ | :------: | ------------ | ----------------------------------------------- | | `tags` | array | ✅ | — | List of tags to create | | `module` | string | ✅ | `"Contacts"` | API name of the module where tags will be added | *** ### `Zoho Bigin Delete Attachment` Integration name: **ZOHO\_BIGIN\_DELETE\_ATTACHMENT** Tool to delete an attachment from a record. Use when you need to remove a file after confirming its record\_id and attachment\_id. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ----------------- | ------ | :------: | ------- | ------------------------------------------------------------------------------------------------------ | | `record_id` | string | ✅ | — | Unique ID of the record from which to delete the attachment. | | `attachment_id` | string | ✅ | — | Unique ID of the attachment to be deleted. | | `module_api_name` | string | ✅ | — | API name of the module. Must be one of: Contacts, Pipelines, Accounts, Products, Tasks, Events, Notes. | *** ### `Zoho Bigin Delete Note` Integration name: **ZOHO\_BIGIN\_DELETE\_NOTE** Tool to delete a note from a specific record. Use when you need to remove a note after confirming its record\_id and note\_id. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ----------------- | ------ | :------: | ------- | ------------------------------------------------------------------------------------------------------ | | `note_id` | string | ✅ | — | Unique ID of the note to be deleted. | | `record_id` | string | ✅ | — | Unique ID of the record from which to delete the note. | | `module_api_name` | string | ✅ | — | API name of the module. Must be one of: Contacts, Accounts, Products, Tasks, Events, Calls, Pipelines. | *** ### `Zoho Bigin Delete Notes` Integration name: **ZOHO\_BIGIN\_DELETE\_NOTES** Tool to delete multiple notes from Zoho Bigin. Use when removing notes after confirming their IDs. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | --------- | ------ | :------: | ----------------------------------------- | ---------------------------------------------------------------------------------- | | `ids` | string | ✅ | `"410405000002264040,410405000002264025"` | Comma-separated note IDs to delete. Example: 410405000002264040,410405000002264025 | *** ### `Zoho Bigin Delete Record` Integration name: **ZOHO\_BIGIN\_DELETE\_RECORD** Tool to delete a specific record from a module. Use when removing a single record after confirming its ID. Can also be used to delink related records. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ----------------- | ------- | :------: | ----------------------- | ----------------------------------------------------------------- | | `record_id` | string | ✅ | `"6796595000000646016"` | Unique identifier of the record to delete | | `wf_trigger` | boolean | | `true` | Whether to trigger workflow rules upon deletion. Defaults to true | | `module_api_name` | string | ✅ | `"Contacts"` | API name of the module to delete the record from | *** ### `Zoho Bigin Delete Record Photo` Integration name: **ZOHO\_BIGIN\_DELETE\_RECORD\_PHOTO** Tool to delete a profile photo from a record. Use when you need to remove the photo associated with a specific record. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ----------------- | ------ | :------: | ------- | ------------------------------------------------------------------------------------------------------ | | `record_id` | string | ✅ | — | Unique ID of the record whose profile photo needs to be deleted. | | `module_api_name` | string | ✅ | — | API name of the module. Must be one of: Contacts, Pipelines, Accounts, Products, Tasks, Events, Calls. | *** ### `Zoho Bigin Delete Records` Integration name: **ZOHO\_BIGIN\_DELETE\_RECORDS** Tool to delete records from a module. Use when removing one or multiple records after confirming their IDs. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ----------------- | ------- | :------: | ---------------------- | ----------------------------------------------- | | `ids` | array | ✅ | `"410405000002264040"` | List of record IDs to delete | | `wf_trigger` | boolean | | `true` | Whether to trigger workflow rules upon deletion | | `module_api_name` | string | ✅ | `"Contacts"` | API name of the module to delete records from | *** ### `Zoho Bigin Delink Related Records` Integration name: **ZOHO\_BIGIN\_DELINK\_RELATED\_RECORDS** Tool to delete the association between a module record and related list records. Use when you need to remove relationships between records without deleting the records themselves. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ----------------------- | ------ | :------: | ------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `ids` | string | | `"6796595000000631011,6796595000000631012"` | Comma-separated list of related record IDs to delink (for multiple records). Maximum 100 records per request. Cannot be used with related\_record\_id parameter. | | `record_id` | string | ✅ | `"6796595000000633033"` | Unique ID of the parent record from which to delink related records | | `module_api_name` | string | ✅ | `"Pipelines"` | API name of the parent module containing the record | | `related_record_id` | string | | `"6796595000000631011"` | ID of a specific related record to delink. Use this for single record delink. Cannot be used with ids parameter. | | `related_list_api_name` | string | ✅ | `"Products"` | API name of the related list (e.g., Products, Contacts, Notes, Activities) | *** ### `Zoho Bigin Disable Notifications` Integration name: **ZOHO\_BIGIN\_DISABLE\_NOTIFICATIONS** Tool to disable instant notifications for one or more channels. Use when you need to stop receiving notifications for specific channels that were previously enabled. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ------------- | ------ | :------: | ----------------- | ------------------------------------------------------------------------------------------------------------ | | `channel_ids` | string | ✅ | `"1000000068001"` | Comma-separated list of unique notification channel IDs to be disabled. Example: 1000000068001,1000000068003 | *** ### `Zoho Bigin Download Attachment` Integration name: **ZOHO\_BIGIN\_DOWNLOAD\_ATTACHMENT** Tool to download an attachment from a record. Use when you need the binary content of a specific attachment after confirming the record and attachment IDs. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ----------------- | ------ | :------: | ---------------------- | ------------------------------------------------------------------------------------------------------------------------ | | `record_id` | string | ✅ | `"410405000002264040"` | The unique identifier of the record from which to download the attachment. | | `attachment_id` | string | ✅ | `"412022000001234567"` | The unique identifier of the attachment to download. | | `module_api_name` | string | ✅ | `"Contacts"` | The API name of the module containing the record. One of: Contacts, Pipelines, Accounts, Products, Tasks, Events, Notes. | *** ### `Zoho Bigin Download Bulk Read Result` Integration name: **ZOHO\_BIGIN\_DOWNLOAD\_BULK\_READ\_RESULT** Tool to download the bulk read job result in ZIP format (containing CSV or ICS export). Use when you need to retrieve completed bulk read job data after obtaining the job\_id from the bulk read job creation or status check. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | --------- | ------ | :------: | ----------------------- | ---------------------------------------------------------------------------------------------------------------- | | `job_id` | string | ✅ | `"6796595000000646005"` | The unique identification of bulk read job, which is obtained from the response of the Create Bulk Read Job API. | *** ### `Zoho Bigin Download Record Photo` Integration name: **ZOHO\_BIGIN\_DOWNLOAD\_RECORD\_PHOTO** Tool to download the profile photo associated with a specific record. Use when you need the binary content of a record's photo after confirming the record ID. Returns HTTP 204 if the record exists but has no photo. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ----------------- | ------ | :------: | ----------------------- | --------------------------------------------------------------------------------------------------- | | `record_id` | string | ✅ | `"6796595000000646033"` | The unique identifier of the record whose profile photo needs to be downloaded. | | `module_api_name` | string | ✅ | `"Contacts"` | The API name of the module containing the record. One of: Contacts, Accounts (Companies), Products. | *** ### `Zoho Bigin Enable Notifications` Integration name: **ZOHO\_BIGIN\_ENABLE\_NOTIFICATIONS** Tool to enable instant webhook notifications for module events in Bigin. Use when you need to receive real-time alerts for record create, edit, or delete operations in specific modules (Contacts, Pipelines, etc.). #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | --------- | ----- | :------: | ------- | -------------------------------------------------------------------------------------------------- | | `watch` | array | ✅ | — | Array of notification configurations to enable. Maximum 100 channels can be configured per request | *** ### `Zoho Bigin Get All Notes` Integration name: **ZOHO\_BIGIN\_GET\_ALL\_NOTES** Tool to retrieve the list of notes associated with records. Use when you need to fetch notes with pagination support. Maximum 200 records per call. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ---------- | ------- | :------: | ------------------------------------- | ---------------------------------------------------------------------------------------------------------- | | `page` | integer | | `1` | Page index for pagination. Defaults to 1. | | `fields` | string | ✅ | `"Note_Title,Note_Content,Parent_Id"` | Comma-separated list of up to 50 field API names to retrieve (e.g., Note\_Title,Note\_Content,Parent\_Id). | | `per_page` | integer | | `50` | Number of records per page. Defaults to 200, max 200. | *** ### `Zoho Bigin Get Attachments` Integration name: **ZOHO\_BIGIN\_GET\_ATTACHMENTS** Tool to retrieve attachments for a record. Use when you need a paginated list of attachments for a given module record. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ----------------- | ------- | :------: | ------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | | `page` | integer | | `1` | Page number for pagination, must be >=1. Default is 1. | | `fields` | string | ✅ | `"File_Name,$file_id,Size,Parent_Id"` | Comma-separated field API names to include in response. Up to 50 fields (e.g., File\_Name,$file\_id,Size,Parent\_Id). | | `per_page` | integer | | `200` | Records per page, must be >=1. Default is 200. | | `record_id` | string | ✅ | `"2034020000000478332"` | Unique identifier of the record. | | `module_api_name` | string | ✅ | `"Contacts"` | API name of the module. | *** ### `Zoho Bigin Get Bulk Read Job Status` Integration name: **ZOHO\_BIGIN\_GET\_BULK\_READ\_JOB\_STATUS** Tool to retrieve the details of a bulk read job performed earlier. Use when you need to check the status of a bulk export operation or download the results after job completion. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | --------- | ------ | :------: | ----------------------- | --------------------------------------------------------------------------------------------------------------- | | `job_id` | string | ✅ | `"6796595000000647006"` | The unique identification of bulk read job, which is obtained from the response of the Create Bulk Read Job API | *** ### `Zoho Bigin Get Custom View` Integration name: **ZOHO\_BIGIN\_GET\_CUSTOM\_VIEW** Tool to get the metadata of a specific custom view configured in a module. Use when you need to retrieve configuration details, criteria, or field lists for a particular custom view. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ---------------- | ------ | :------: | ----------------------- | --------------------------------------------------------------------- | | `module` | string | ✅ | `"Contacts"` | API name of the module (e.g., Contacts, Deals, Companies, Pipelines). | | `custom_view_id` | string | ✅ | `"6796595000000087529"` | The unique ID of the custom view to retrieve metadata for. | *** ### `Zoho Bigin Get Custom Views` Integration name: **ZOHO\_BIGIN\_GET\_CUSTOM\_VIEWS** Tool to retrieve the list of custom views available for a module. Use when you need to discover which custom views exist for a specific Bigin module. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | --------- | ------ | :------: | ------------ | -------------------------------------------------------- | | `module` | string | ✅ | `"Contacts"` | The API name of the module to retrieve custom views for. | *** ### `Zoho Bigin Get Deleted Records` Integration name: **ZOHO\_BIGIN\_GET\_DELETED\_RECORDS** Tool to get a list of deleted records in a module. Use when auditing or restoring recently deleted data (recycle within 60 days, permanent within 120 days). #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ----------------- | ------- | :------: | ------------ | ------------------------------------------------------------------------------------------------------------- | | `page` | integer | | `1` | Page number for pagination (starts at 1). | | `type` | string | | `"all"` | Type of deleted records to retrieve: all (default), recycle (in bin ≤60 days), permanent (deleted ≤120 days). | | `per_page` | integer | | `50` | Number of records per page (max 200). | | `module_api_name` | string | ✅ | `"Contacts"` | API name of the module to retrieve deleted records from. | *** ### `Zoho Bigin Get Fields` Integration name: **ZOHO\_BIGIN\_GET\_FIELDS** Tool to retrieve field metadata for a Bigin module. Use when you need to discover available fields, their types, validation rules, and picklist values for a module. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | --------- | ------ | :------: | ------------ | ------------------------------------------------------ | | `module` | string | ✅ | `"Contacts"` | API name of the module to retrieve field metadata for. | *** ### `Zoho Bigin Get Layout` Integration name: **ZOHO\_BIGIN\_GET\_LAYOUT** Tool to retrieve details of a specific layout by layout ID. Use when you need to get detailed configuration, sections, fields, and permissions for a particular layout. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ----------- | ------ | :------: | ----------------------- | ---------------------------------------------------------------- | | `module` | string | ✅ | `"Contacts"` | The API name of the module for which to retrieve layout details. | | `layout_id` | string | ✅ | `"6796595000000091033"` | The unique ID of the layout to retrieve. | *** ### `Zoho Bigin Get Layouts` Integration name: **ZOHO\_BIGIN\_GET\_LAYOUTS** Tool to retrieve the list of layouts available for a module. Use when you need to discover layout metadata, sections, fields, and configuration for a specific module. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | --------- | ------ | :------: | ------------ | ----------------------------------------------------------------- | | `module` | string | ✅ | `"Contacts"` | The API name of the module for which to retrieve layout metadata. | *** ### `Zoho Bigin Get Module Metadata` Integration name: **ZOHO\_BIGIN\_GET\_MODULE\_METADATA** Tool to retrieve metadata of a specific module by its API name. Use when you need detailed information about a module's configuration, permissions, and features. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ----------------- | ------ | :------: | ------------ | ----------------------------------------------- | | `module_api_name` | string | ✅ | `"Contacts"` | API name of the module to retrieve metadata for | *** ### `Zoho Bigin Get Modules` Integration name: **ZOHO\_BIGIN\_GET\_MODULES** Tool to retrieve a list of all modules. Use when you need to discover which modules are available in Bigin. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. *No parameters required.* *** ### `Zoho Bigin Get Notification Details` Integration name: **ZOHO\_BIGIN\_GET\_NOTIFICATION\_DETAILS** Tool to retrieve information about enabled notifications. Use when you need to list notification channels, check their configuration, or verify which modules have active notifications. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ------------ | ------- | :------: | ----------------- | -------------------------------------------------------------------------------------------------------------------------- | | `page` | integer | | `1` | Page index for pagination. Defaults to 1. | | `module` | string | | `"Contacts"` | API name of the module to filter notifications. Only returns notifications for the specified module. | | `per_page` | integer | | `50` | Number of records per page. Defaults to 200, maximum is 200. | | `channel_id` | string | | `"1000000068001"` | Unique identifier of a channel that is set while enabling a notification. Use to filter notifications by specific channel. | *** ### `Zoho Bigin Get Organization` Integration name: **ZOHO\_BIGIN\_GET\_ORGANIZATION** Tool to retrieve organization details including name, ID, currency, time zone, and other settings. Use when you need to fetch organization-level configuration and metadata. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. *No parameters required.* *** ### `Zoho Bigin Get Profiles` Integration name: **ZOHO\_BIGIN\_GET\_PROFILES** Tool to retrieve the list of available profiles and their properties in an organization. Use when you need to discover which profiles exist in Bigin. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. *No parameters required.* *** ### `Zoho Bigin Get Record` Integration name: **ZOHO\_BIGIN\_GET\_RECORD** Tool to retrieve details of a specific record in a module using the record ID. Use when you need to fetch complete information about a single record by its ID. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ----------------- | ------ | :------: | ----------------------- | --------------------------------------------------------- | | `record_id` | string | ✅ | `"6796595000000634014"` | The unique ID of the record to retrieve. | | `module_api_name` | string | ✅ | `"Contacts"` | API name of the Bigin module to retrieve the record from. | *** ### `Zoho Bigin Get Record Notes` Integration name: **ZOHO\_BIGIN\_GET\_RECORD\_NOTES** Tool to retrieve the list of notes associated with a specific record. Use when you need to fetch notes for a given module record with optional field filtering and pagination. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ----------------- | ------- | :------: | ------------------------------ | -------------------------------------------------------------------------------------------------------- | | `page` | integer | | `1` | Page index for pagination. Default is 1. | | `fields` | string | ✅ | `"id,Note_Title,Note_Content"` | Comma-separated field API names to retrieve (max 50 fields). Example: id,Note\_Title,Note\_Content. | | `per_page` | integer | | `50` | Number of records per page. Default is 200, max 200 per call. | | `record_id` | string | ✅ | `"6796595000000648013"` | The unique identification of a record in a module. | | `module_api_name` | string | ✅ | `"Contacts"` | API name of the module. Supported values: Contacts, Pipelines, Accounts, Products, Tasks, Events, Calls. | *** ### `Zoho Bigin Get Records` Integration name: **ZOHO\_BIGIN\_GET\_RECORDS** Tool to retrieve records from a Bigin module. Use when listing or paginating module data with specific fields, sorting, filtering. No free-text search supported; use cvid for saved view filtering. Records are nested under result\['data']\['data']; check result\['data']\['info']\['more\_records'] to detect additional pages. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ----------------- | ------- | :------: | ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `cvid` | string | | `"203402000000123456"` | Custom view ID to filter by a saved custom view. Cannot be used together with sort\_by parameter. | | `page` | integer | | `1` | Page index for pagination (1-indexed). Cannot be used with page\_token. | | `fields` | string | ✅ | `"Last_Name,Email"` | Comma-separated list of up to 50 field API names to retrieve. All desired fields including 'id' must be explicitly listed — unlisted fields are absent from results even if populated on the record. | | `sort_by` | string | | `"id"` | Field API name to sort by. Supported values: 'id', 'Created\_Time', 'Modified\_Time'. Cannot be used together with cvid parameter. | | `approved` | string | | `"both"` | Filter by approval status: 'true', 'false', or 'both'. | | `per_page` | integer | | `50` | Number of records per page. Max 200. | | `page_token` | string | | `"cd2cb80b7af..."` | Token from previous response for beyond-2000 retrieval. Cannot be used with page. Check response info.more\_records (bool) to determine if additional pages exist before issuing the next request. | | `sort_order` | string | | `"desc"` | Sort order: 'asc' or 'desc'. Applies when sort\_by is provided. | | `module_api_name` | string | ✅ | `"Contacts"` | API name of the Bigin module to retrieve records from. | *** ### `Zoho Bigin Get Records Count` Integration name: **ZOHO\_BIGIN\_GET\_RECORDS\_COUNT** Tool to get the count of records in a Bigin module. Use when you need to know how many records exist in a module, optionally filtered by a custom view. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ----------------- | ------ | :------: | --------------- | -------------------------------------------------------------------------------------------------------------------------- | | `cvid` | string | | `"5690xxxx980"` | Custom view ID to filter the count by a saved custom view. Use Custom Views Metadata API to get available custom view IDs. | | `module_api_name` | string | ✅ | `"Contacts"` | API name of the Bigin module to count records in. | *** ### `Zoho Bigin Get Related Lists Metadata` Integration name: **ZOHO\_BIGIN\_GET\_RELATED\_LISTS\_METADATA** Tool to retrieve the list of related lists metadata for a module. Use when you need to discover which related lists are available for a specific module. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | --------- | ------ | :------: | ------------ | --------------------------------------------------------------------------------------------------------------------------- | | `module` | string | ✅ | `"Contacts"` | The API name of the module. Supported values: Contacts, Pipelines, Accounts (for Companies), Products, Tasks, Events, Calls | *** ### `Zoho Bigin Get Related Records` Integration name: **ZOHO\_BIGIN\_GET\_RELATED\_RECORDS** Tool to retrieve related records associated with a specific record in a module. Use when fetching related data like Notes, Attachments, Products, or Activities linked to a parent record. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ----------------------- | ------- | :------: | ------------------------------ | ----------------------------------------------------------------------------------------------------- | | `page` | integer | | `1` | Page number for pagination. Defaults to 1. | | `fields` | string | ✅ | `"id,Note_Title,Note_Content"` | Comma-separated list of field API names to retrieve. Required for most related lists (except Emails). | | `per_page` | integer | | `50` | Number of records per page. Defaults to 200, max 200. | | `record_id` | string | ✅ | `"6796595000000634014"` | Unique identifier of the record for which to retrieve related records. | | `module_api_name` | string | ✅ | `"Contacts"` | API name of the module (e.g., Contacts, Pipelines, Products, Companies). | | `related_list_api_name` | string | ✅ | `"Notes"` | API name of the related list (e.g., Notes, Activities, Products, Attachments). | *** ### `Zoho Bigin Get Roles` Integration name: **ZOHO\_BIGIN\_GET\_ROLES** Tool to retrieve the list of available roles and their properties in an organization. Use when you need to discover role hierarchy and permissions. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. *No parameters required.* *** ### `Zoho Bigin Get Team Pipeline Records` Integration name: **ZOHO\_BIGIN\_GET\_TEAM\_PIPELINE\_RECORDS** Tool to retrieve pipeline records from Team Pipelines in Zoho Bigin. Use when you need to fetch deals or records from a specific team pipeline with filtering, sorting, and pagination. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ------------- | ------- | :------: | ---------------------------------------------------- | ---------------------------------------------------------------------------- | | `page` | integer | | `1` | Page index for pagination. Defaults to 1. | | `fields` | string | ✅ | `"Deal_Name,Sub_Pipeline,Stage,Amount,Closing_Date"` | Comma-separated list of field API names to retrieve (max 50 fields). | | `sort_by` | string | | `"id"` | Field to sort by. Supported values: 'id', 'Created\_Time', 'Modified\_Time'. | | `per_page` | integer | | `10` | Number of records per page. Defaults to 200, max 200. | | `sort_order` | string | | `"asc"` | Sort order: 'asc' for ascending or 'desc' for descending. | | `pipeline_id` | string | ✅ | `"6796595000000091023"` | The unique identification of a Team Pipeline. | *** ### `Zoho Bigin Get User` Integration name: **ZOHO\_BIGIN\_GET\_USER** Tool to retrieve details of a specific user using the user identification. Use when you need to get complete information about a single user by their ID. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | --------- | ------ | :------: | ----------------------- | -------------------------------------------------- | | `user_id` | string | ✅ | `"6796595000000563001"` | The unique identification of the user to retrieve. | *** ### `Zoho Bigin Get Users` Integration name: **ZOHO\_BIGIN\_GET\_USERS** Tool to retrieve the list of users in the organization. Use when you need to get user information with filtering by type (ActiveUsers, DeactiveUsers, AdminUsers, etc.). #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ---------- | ------- | :------: | --------------- | ---------------------------------------------- | | `page` | integer | | `1` | Page number for pagination. | | `type` | string | | `"ActiveUsers"` | User type filter options for retrieving users. | | `per_page` | integer | | `50` | Number of records per page. | *** ### `Zoho Bigin Search Records` Integration name: **ZOHO\_BIGIN\_SEARCH\_RECORDS** Tool to search for records in a Bigin module using various criteria. Use when you need to find records by keyword, email, phone, or custom criteria with specific field comparators. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ----------------- | ------- | :------: | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `page` | integer | | `1` | Page number for pagination. Defaults to 1. | | `word` | string | | `"test"` | Keyword to search across all available fields in the module. Cannot be used with email, phone, or criteria. | | `email` | string | | `"john@example.com"` | Search by email address. Searches through all email fields associated with the module. Cannot be used with word, phone, or criteria. | | `phone` | string | | `"+1234567890"` | Search by phone number. Searches through all phone number fields associated with the module. Cannot be used with word, email, or criteria. | | `fields` | string | | `"Last_Name,Email,Phone"` | Comma-separated list of field API names to retrieve. If not specified, all fields are returned. | | `criteria` | string | | `"(Last_Name:equals:Smith)"` | Custom search criteria expression with field comparators (e.g., '(Last\_Name:equals:Smith)and(Email:contains:example)'). Cannot be used with word, email, or phone. | | `per_page` | integer | | `50` | Number of records per page. Defaults to 200, max 200. | | `module_api_name` | string | ✅ | `"Contacts"` | API name of the Bigin module to search records in. | *** ### `Zoho Bigin Update Note` Integration name: **ZOHO\_BIGIN\_UPDATE\_NOTE** Tool to update an existing note for a specific record in a module. Use when you need to modify the title or content of a note after confirming the module name, record ID, and note ID. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ----------------- | ------ | :------: | ---------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | | `note_id` | string | ✅ | `"6796595000000568059"` | Unique identifier of the note to update | | `record_id` | string | ✅ | `"6796595000000568043"` | Unique identifier of the record that contains the note | | `Note_Title` | string | | `"Updated Note Title via API"` | Updated title for the note | | `Note_Content` | string | | `"This note has been successfully updated using the API."` | Updated content/body text for the note | | `module_api_name` | string | ✅ | `"Pipelines"` | API name of the module containing the record with the note. Allowed: Contacts, Pipelines, Accounts, Products, Tasks, Events, Calls | *** ### `Zoho Bigin Update Notification Details` Integration name: **ZOHO\_BIGIN\_UPDATE\_NOTIFICATION\_DETAILS** Tool to update notification channel details in Zoho Bigin. Use when you need to modify notification URLs, events, tokens, or expiry times for existing channels. Supports up to 100 channels per call. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | --------- | ----- | :------: | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- | | `watch` | array | ✅ | `[{"token":"updated_token","events":["Contacts.create","Contacts.edit"],"channel_id":"1000000001","notify_url":"https://webhook.site/updated-url"}]` | List of channels to update (max 100 per API call) | *** ### `Zoho Bigin Update Notification Info` Integration name: **ZOHO\_BIGIN\_UPDATE\_NOTIFICATION\_INFO** Tool to update specific notification information without losing existing data. Use when you need to modify notification channel settings such as events, expiry, token, or webhook URL. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | --------- | ----- | :------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | | `watch` | array | ✅ | `[{"token":"updated_token_456","events":["Contacts.create","Contacts.edit"],"channel_id":"1000000000001","notify_url":"https://webhook.site/unique-test-url-updated","channel_expiry":"2026-02-17T12:00:00+00:00"}]` | List of watch configurations to update. Each must include channel\_id and optional fields to update | *** ### `Zoho Bigin Update Records` Integration name: **ZOHO\_BIGIN\_UPDATE\_RECORDS** Tool to update existing records in a module. Use when you need to modify one or multiple records after confirming their IDs and field API names. Supports up to 100 records per call; specify an optional trigger to control workflow execution. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ----------------- | ------ | :------: | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `data` | array | ✅ | — | List of JSON objects to update. Each object must include 'id' and the fields to modify. Max 100 records per call. Invalid or misspelled field API names are silently ignored — the call succeeds but those fields remain unchanged. Verify exact field API names before submitting. | | `trigger` | array | | `[]` | Array of workflow triggers. Default executes workflows; provide \[] to skip workflow execution. | | `record_id` | string | | `"2034020000000489124"` | Optional ID of a single record to update. If omitted, all IDs in `data` will be updated in bulk. If multiple records match search criteria, request user clarification to confirm the correct ID before updating. | | `module_api_name` | string | ✅ | `"Contacts"` | API name of the module to update records in. Allowed: Contacts, Pipelines, Accounts, Products, Tasks, Events, Calls | *** ### `Zoho Bigin Update Related Records` Integration name: **ZOHO\_BIGIN\_UPDATE\_RELATED\_RECORDS** Tool to update related records associated with a specific record in a module. Use when you need to modify existing relationships such as updating notes, products, or activities linked to a contact or account. Max 100 records per call. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ----------------------- | ------ | :------: | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | | `data` | array | ✅ | — | Array of related records to update. Each object must contain 'id' field and any additional fields to modify. Max 100 records per call | | `record_id` | string | ✅ | `"6796595000000648013"` | Unique identifier of the parent record | | `module_api_name` | string | ✅ | `"Contacts"` | API name of the module containing the parent record. Allowed: Contacts, Pipelines, Accounts, Products, Tasks, Events, Calls | | `related_list_api_name` | string | ✅ | `"Notes"` | API name of the related list (e.g., Notes, Activities, Products). This identifies the type of related records to update | *** ### `Zoho Bigin Update User` Integration name: **ZOHO\_BIGIN\_UPDATE\_USER** Tool to update details of an existing user by user ID. Use when you need to modify user information such as phone, date of birth, time format, role, or status. Cannot update deactivated users. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ---------------- | ------ | :------: | ----------------------- | ---------------------------------------------------------------------------------------------------- | | `dob` | string | | `"1990-05-15"` | Date of birth in YYYY-MM-DD format. | | `role` | string | | `"2034020000000026005"` | Role ID to assign to the user. Must be a valid role identifier in your organization. | | `phone` | string | | `"+1-202-555-0120"` | Phone number for the user. Should include country code (e.g., +1-202-555-0120). | | `status` | string | | `"active"` | User status options. | | `user_id` | string | ✅ | `"6796595000000563001"` | Unique identifier of the user to update. This is a required path parameter. | | `time_format` | string | | `"HH:mm"` | Preferred time format for the user. Common formats: HH:mm (24-hour) or hh:mm a (12-hour with AM/PM). | | `country_locale` | string | | `"en_US"` | Country locale setting for the user (e.g., en\_US, en\_GB). | *** ### `Zoho Bigin Update Users` Integration name: **ZOHO\_BIGIN\_UPDATE\_USERS** Tool to update details of multiple users in an organization. Use when you need to modify user information such as phone, date of birth, time format, role, or status. Cannot update deactivated users. Maximum 100 users per request. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | --------- | ----- | :------: | ------- | -------------------------------------------------------------------------------------------------------------------------------- | | `users` | array | ✅ | — | Array of user objects to update. Each object must include the user's ID and the fields to modify. Maximum 100 users per request. | *** ### `Zoho Bigin Upload Attachment` Integration name: **ZOHO\_BIGIN\_UPLOAD\_ATTACHMENT** Tool to upload an attachment to a record. Use when you need to attach a file or specify a public URL for upload to a Bigin record. Ensure module\_api\_name and record\_id are correct before calling. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ----------------- | ------ | :------: | --------------------------------- | ------------------------------------------------------------------------ | | `file` | object | | — | File to upload as an attachment. Provide either this or attachment\_url. | | `record_id` | string | ✅ | `"2034020000000478332"` | Unique identifier of the record. | | `attachment_url` | string | | `"https://example.com/photo.jpg"` | Public URL of the attachment to upload. Provide either this or file. | | `module_api_name` | string | ✅ | `"Contacts"` | API name of the module to which the attachment should be added. | *** ### `Zoho Bigin Upload Organization Photo` Integration name: **ZOHO\_BIGIN\_UPLOAD\_ORGANIZATION\_PHOTO** Tool to upload or update the brand logo or image for the current organization. Use when you need to set or change the organization's photo/logo in Zoho Bigin. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | --------- | ------ | :------: | ------- | ------------------------------------------------------------------------------------------------------------------------------------ | | `file` | object | ✅ | — | The photo file to upload. Maximum size: 1 MB. Maximum resolution: 10 MP. Supported formats: image files (png, jpg, jpeg, gif, etc.). | *** ### `Zoho Bigin Upload Record Photo` Integration name: **ZOHO\_BIGIN\_UPLOAD\_RECORD\_PHOTO** Tool to upload a photo/image to a specific record (e.g., contact photo). Use when you need to attach a profile picture or image to a Bigin record. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ----------------- | ------ | :------: | ----------------------- | ----------------------------------------------------------------------------------------------- | | `file` | object | ✅ | — | Photo/image file to upload. Photo must not exceed 10 MB in size or 10 megapixels in resolution. | | `record_id` | string | ✅ | `"6796595000000648013"` | Unique identifier of the record to upload the photo to. | | `module_api_name` | string | ✅ | `"Contacts"` | API name of the module containing the record (e.g., Contacts, Accounts). | *** ### `Zoho Bigin Upsert Records` Integration name: **ZOHO\_BIGIN\_UPSERT\_RECORDS** Tool to insert or update records in a module based on unique field values. Use when you need to sync data without checking if records exist first. Updates existing records if duplicates are found, otherwise inserts new records. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ------------------------ | ------ | :------: | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `data` | array | ✅ | — | List of JSON objects to upsert. Each object maps Field API names to values. Max 100 records per call. | | `trigger` | array | | `[]` | Array of workflow triggers: 'workflow', 'approval', 'blueprint'. Default executes workflows; provide \[] to skip workflow execution. | | `module_api_name` | string | ✅ | `"Contacts"` | API name of the module to upsert records into. Allowed: Contacts, Accounts, Products. Note: Pipelines, Tasks, Events, and Calls modules may not support upsert operations in all Bigin instances. | | `duplicate_check_fields` | array | | `["Email"]` | Array of field API names to check for duplicates. If a record with matching values exists, it will be updated; otherwise, inserted. Example: \['Email'] to match by email address. | --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.toolhouse.ai/toolhouse/integrations/zoho-bigin.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.