# Zoho Bigin

Zoho Bigin is a simplified CRM solution from Zoho tailored for small businesses, focusing on pipeline tracking and relationship management

- **Category:** crm
- **Auth:** OAUTH2
- **Composio Managed App Available?** Yes
- **Tools:** 54
- **Triggers:** 0
- **Slug:** `ZOHO_BIGIN`
- **Version:** 20260316_00

## Tools

### Add Records

**Slug:** `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. Provide required fields per module (e.g., Contacts requires Last_Name).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | Yes | List of JSON objects to insert. Each object maps Field API names to values. Max 100 records per call. |
| `trigger` | array | No | Array of workflow triggers. Default ['workflow'] executes workflows; use [] to skip workflows. |
| `module_api_name` | string ("Contacts" | "Pipelines" | "Accounts" | "Products" | "Tasks" | "Events" | "Calls") | Yes | The API name of the module to insert into. Allowed: Contacts, Pipelines, Accounts, Products, Tasks, Events, Calls |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Tags to Records

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | array | Yes | List of tag objects to add to the record |
| `record_id` | string | Yes | Unique identifier of the record to which tags will be added |
| `over_write` | boolean | No | Whether to overwrite existing tags (default: false) |
| `module_api_name` | string ("Contacts" | "Pipelines" | "Accounts" | "Products" | "Tasks" | "Events" | "Calls") | Yes | API name of the module where record resides |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Bulk Read Job

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | object | Yes | Query configuration specifying the module and optional filters for the bulk export. |
| `callback` | object | No | Callback configuration for job completion notification. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Notes

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | Yes | Array of note objects to create. Each note must specify content, parent record, and module. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Record Notes

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | Yes | List of note objects to create. Each note must have Note_Content; Note_Title is optional. |
| `record_id` | string | Yes | Unique identifier of the record to add notes to. |
| `module_api_name` | string ("Contacts" | "Pipelines" | "Accounts" | "Products" | "Tasks" | "Events" | "Calls") | Yes | API name of the module. Must be one of: Contacts, Pipelines, Accounts, Products, Tasks, Events, Calls. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Tags

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | array | Yes | List of tags to create |
| `module` | string ("Contacts" | "Pipelines" | "Accounts" | "Products" | "Tasks" | "Events" | "Calls") | Yes | API name of the module where tags will be added |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Attachment

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `record_id` | string | Yes | Unique ID of the record from which to delete the attachment. |
| `attachment_id` | string | Yes | Unique ID of the attachment to be deleted. |
| `module_api_name` | string ("Contacts" | "Pipelines" | "Accounts" | "Products" | "Tasks" | "Events" | "Notes") | Yes | API name of the module. Must be one of: Contacts, Pipelines, Accounts, Products, Tasks, Events, Notes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Note

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `note_id` | string | Yes | Unique ID of the note to be deleted. |
| `record_id` | string | Yes | Unique ID of the record from which to delete the note. |
| `module_api_name` | string ("Contacts" | "Accounts" | "Products" | "Tasks" | "Events" | "Calls" | "Pipelines") | Yes | API name of the module. Must be one of: Contacts, Accounts, Products, Tasks, Events, Calls, Pipelines. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Notes

**Slug:** `ZOHO_BIGIN_DELETE_NOTES`

Tool to delete multiple notes from Zoho Bigin. Use when removing notes after confirming their IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | string | Yes | Comma-separated note IDs to delete. Example: 410405000002264040,410405000002264025 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Record

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `record_id` | string | Yes | Unique identifier of the record to delete |
| `wf_trigger` | boolean | No | Whether to trigger workflow rules upon deletion. Defaults to true |
| `module_api_name` | string ("Contacts" | "Pipelines" | "Accounts" | "Products" | "Tasks" | "Events" | "Calls") | Yes | API name of the module to delete the record from |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Record Photo

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `record_id` | string | Yes | Unique ID of the record whose profile photo needs to be deleted. |
| `module_api_name` | string ("Contacts" | "Pipelines" | "Accounts" | "Products" | "Tasks" | "Events" | "Calls") | Yes | API name of the module. Must be one of: Contacts, Pipelines, Accounts, Products, Tasks, Events, Calls. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Records

**Slug:** `ZOHO_BIGIN_DELETE_RECORDS`

Tool to delete records from a module. Use when removing one or multiple records after confirming their IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | array | Yes | List of record IDs to delete |
| `wf_trigger` | boolean | No | Whether to trigger workflow rules upon deletion |
| `module_api_name` | string ("Contacts" | "Pipelines" | "Accounts" | "Products" | "Tasks" | "Events" | "Calls") | Yes | API name of the module to delete records from |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delink Related Records

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | string | No | 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 | Yes | Unique ID of the parent record from which to delink related records |
| `module_api_name` | string ("Contacts" | "Pipelines" | "Accounts" | "Products" | "Tasks" | "Events" | "Calls") | Yes | API name of the parent module containing the record |
| `related_record_id` | string | No | 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 | Yes | API name of the related list (e.g., Products, Contacts, Notes, Activities) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Disable Notifications

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `channel_ids` | string | Yes | Comma-separated list of unique notification channel IDs to be disabled. Example: 1000000068001,1000000068003 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Attachment

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `record_id` | string | Yes | The unique identifier of the record from which to download the attachment. |
| `attachment_id` | string | Yes | The unique identifier of the attachment to download. |
| `module_api_name` | string ("Contacts" | "Pipelines" | "Accounts" | "Products" | "Tasks" | "Events" | "Notes") | Yes | The API name of the module containing the record. One of: Contacts, Pipelines, Accounts, Products, Tasks, Events, Notes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Bulk Read Result

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | string | Yes | The unique identification of bulk read job, which is obtained from the response of the Create Bulk Read Job API. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Record Photo

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `record_id` | string | Yes | The unique identifier of the record whose profile photo needs to be downloaded. |
| `module_api_name` | string ("Contacts" | "Accounts" | "Products") | Yes | The API name of the module containing the record. One of: Contacts, Accounts (Companies), Products. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Enable Notifications

**Slug:** `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.).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `watch` | array | Yes | Array of notification configurations to enable. Maximum 100 channels can be configured per request |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get All Notes

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page index for pagination. Defaults to 1. |
| `fields` | string | Yes | Comma-separated list of up to 50 field API names to retrieve (e.g., Note_Title,Note_Content,Parent_Id). |
| `per_page` | integer | No | Number of records per page. Defaults to 200, max 200. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Attachments

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination, must be >=1. Default is 1. |
| `fields` | string | Yes | 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 | No | Records per page, must be >=1. Default is 200. |
| `record_id` | string | Yes | Unique identifier of the record. |
| `module_api_name` | string ("Contacts" | "Pipelines" | "Accounts" | "Products" | "Tasks" | "Events" | "Notes") | Yes | API name of the module. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Bulk Read Job Status

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | string | Yes | The unique identification of bulk read job, which is obtained from the response of the Create Bulk Read Job API |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Custom View

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `module` | string | Yes | API name of the module (e.g., Contacts, Deals, Companies, Pipelines). |
| `custom_view_id` | string | Yes | The unique ID of the custom view to retrieve metadata for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Custom Views

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `module` | string ("Contacts" | "Pipelines" | "Accounts" | "Products" | "Tasks" | "Events" | "Calls" | "Associate_Products" | "Notes" | "Attachments") | Yes | The API name of the module to retrieve custom views for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Deleted Records

**Slug:** `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).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination (starts at 1). |
| `type` | string ("all" | "recycle" | "permanent") | No | Type of deleted records to retrieve: all (default), recycle (in bin ≤60 days), permanent (deleted ≤120 days). |
| `per_page` | integer | No | Number of records per page (max 200). |
| `module_api_name` | string ("Contacts" | "Pipelines" | "Accounts" | "Products" | "Tasks" | "Events" | "Calls") | Yes | API name of the module to retrieve deleted records from. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Fields

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `module` | string ("Contacts" | "Pipelines" | "Accounts" | "Products" | "Tasks" | "Events" | "Calls") | Yes | API name of the module to retrieve field metadata for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Layout

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `module` | string ("Contacts" | "Pipelines" | "Accounts" | "Products" | "Tasks" | "Events" | "Calls" | "Associate_Products" | "Notes" | "Attachments") | Yes | The API name of the module for which to retrieve layout details. |
| `layout_id` | string | Yes | The unique ID of the layout to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Layouts

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `module` | string ("Contacts" | "Pipelines" | "Accounts" | "Products" | "Tasks" | "Events" | "Calls" | "Associate_Products" | "Notes" | "Attachments") | Yes | The API name of the module for which to retrieve layout metadata. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Module Metadata

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `module_api_name` | string ("Contacts" | "Pipelines" | "Accounts" | "Products" | "Tasks" | "Events" | "Calls" | "Associate_Products" | "Notes" | "Attachments") | Yes | API name of the module to retrieve metadata for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Modules

**Slug:** `ZOHO_BIGIN_GET_MODULES`

Tool to retrieve a list of all modules. Use when you need to discover which modules are available in Bigin.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Notification Details

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page index for pagination. Defaults to 1. |
| `module` | string ("Contacts" | "Pipelines" | "Accounts" | "Products" | "Tasks" | "Events" | "Calls") | No | API name of the module to filter notifications. Only returns notifications for the specified module. |
| `per_page` | integer | No | Number of records per page. Defaults to 200, maximum is 200. |
| `channel_id` | string | No | Unique identifier of a channel that is set while enabling a notification. Use to filter notifications by specific channel. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Organization

**Slug:** `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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Profiles

**Slug:** `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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Record

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `record_id` | string | Yes | The unique ID of the record to retrieve. |
| `module_api_name` | string ("Contacts" | "Pipelines" | "Accounts" | "Products" | "Tasks" | "Events" | "Calls") | Yes | API name of the Bigin module to retrieve the record from. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Record Notes

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page index for pagination. Default is 1. |
| `fields` | string | Yes | Comma-separated field API names to retrieve (max 50 fields). Example: id,Note_Title,Note_Content. |
| `per_page` | integer | No | Number of records per page. Default is 200, max 200 per call. |
| `record_id` | string | Yes | The unique identification of a record in a module. |
| `module_api_name` | string ("Contacts" | "Pipelines" | "Accounts" | "Products" | "Tasks" | "Events" | "Calls") | Yes | API name of the module. Supported values: Contacts, Pipelines, Accounts, Products, Tasks, Events, Calls. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Records

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cvid` | string | No | Custom view ID to filter by a saved custom view. Cannot be used together with sort_by parameter. |
| `page` | integer | No | Page index for pagination. Defaults to 1. |
| `fields` | string | Yes | 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" | "Created_Time" | "Modified_Time") | No | Field API name to sort by. Supported values: 'id', 'Created_Time', 'Modified_Time'. Cannot be used together with cvid parameter. |
| `approved` | string ("true" | "false" | "both") | No | Filter by approval status: 'true', 'false', or 'both'. |
| `per_page` | integer | No | Number of records per page. Defaults to 200, max 200. |
| `page_token` | string | No | Token from previous response for beyond-2000 retrieval. Check response info.more_records (bool) to determine if additional pages exist before issuing the next request. |
| `sort_order` | string ("asc" | "desc") | No | Sort order: 'asc' or 'desc'. Applies when sort_by is provided. |
| `module_api_name` | string ("Contacts" | "Pipelines" | "Accounts" | "Products" | "Tasks" | "Events" | "Calls") | Yes | API name of the Bigin module to retrieve records from. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Records Count

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cvid` | string | No | 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" | "Pipelines" | "Accounts" | "Products" | "Tasks" | "Events" | "Calls") | Yes | API name of the Bigin module to count records in. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Related Lists Metadata

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `module` | string ("Contacts" | "Pipelines" | "Accounts" | "Products" | "Tasks" | "Events" | "Calls") | Yes | The API name of the module. Supported values: Contacts, Pipelines, Accounts (for Companies), Products, Tasks, Events, Calls |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Related Records

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Defaults to 1. |
| `fields` | string | Yes | Comma-separated list of field API names to retrieve. Required for most related lists (except Emails). |
| `per_page` | integer | No | Number of records per page. Defaults to 200, max 200. |
| `record_id` | string | Yes | Unique identifier of the record for which to retrieve related records. |
| `module_api_name` | string | Yes | API name of the module (e.g., Contacts, Pipelines, Products, Companies). |
| `related_list_api_name` | string | Yes | API name of the related list (e.g., Notes, Activities, Products, Attachments). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Roles

**Slug:** `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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Team Pipeline Records

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page index for pagination. Defaults to 1. |
| `fields` | string | Yes | Comma-separated list of field API names to retrieve (max 50 fields). |
| `sort_by` | string ("id" | "Created_Time" | "Modified_Time") | No | Field to sort by. Supported values: 'id', 'Created_Time', 'Modified_Time'. |
| `per_page` | integer | No | Number of records per page. Defaults to 200, max 200. |
| `sort_order` | string ("asc" | "desc") | No | Sort order: 'asc' for ascending or 'desc' for descending. |
| `pipeline_id` | string | Yes | The unique identification of a Team Pipeline. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | Yes | The unique identification of the user to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Users

**Slug:** `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.).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. |
| `type` | string ("AllUsers" | "ActiveUsers" | "DeactiveUsers" | "ConfirmedUsers" | "NotConfirmedUsers" | "DeletedUsers" | "ActiveConfirmedUsers" | "AdminUsers" | "ActiveConfirmedAdmins" | "CurrentUser") | No | User type filter options for retrieving users. |
| `per_page` | integer | No | Number of records per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Records

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Defaults to 1. |
| `word` | string | No | Keyword to search across all available fields in the module. Cannot be used with email, phone, or criteria. |
| `email` | string | No | Search by email address. Searches through all email fields associated with the module. Cannot be used with word, phone, or criteria. |
| `phone` | string | No | Search by phone number. Searches through all phone number fields associated with the module. Cannot be used with word, email, or criteria. |
| `fields` | string | No | Comma-separated list of field API names to retrieve. If not specified, all fields are returned. |
| `criteria` | string | No | 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 | No | Number of records per page. Defaults to 200, max 200. |
| `module_api_name` | string ("Contacts" | "Pipelines" | "Accounts" | "Products" | "Tasks" | "Events" | "Calls") | Yes | API name of the Bigin module to search records in. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Note

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `note_id` | string | Yes | Unique identifier of the note to update |
| `record_id` | string | Yes | Unique identifier of the record that contains the note |
| `Note_Title` | string | No | Updated title for the note |
| `Note_Content` | string | No | Updated content/body text for the note |
| `module_api_name` | string ("Contacts" | "Pipelines" | "Accounts" | "Products" | "Tasks" | "Events" | "Calls") | Yes | API name of the module containing the record with the note. Allowed: Contacts, Pipelines, Accounts, Products, Tasks, Events, Calls |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Notification Details

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `watch` | array | Yes | List of channels to update (max 100 per API call) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Notification Info

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `watch` | array | Yes | List of watch configurations to update. Each must include channel_id and optional fields to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Records

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | Yes | 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 | No | Array of workflow triggers. Default executes workflows; provide [] to skip workflow execution. |
| `record_id` | string | No | 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" | "Pipelines" | "Accounts" | "Products" | "Tasks" | "Events" | "Calls") | Yes | API name of the module to update records in. Allowed: Contacts, Pipelines, Accounts, Products, Tasks, Events, Calls |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Related Records

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | Yes | 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 | Yes | Unique identifier of the parent record |
| `module_api_name` | string ("Contacts" | "Pipelines" | "Accounts" | "Products" | "Tasks" | "Events" | "Calls") | Yes | API name of the module containing the parent record. Allowed: Contacts, Pipelines, Accounts, Products, Tasks, Events, Calls |
| `related_list_api_name` | string | Yes | API name of the related list (e.g., Notes, Activities, Products). This identifies the type of related records to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update User

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dob` | string | No | Date of birth in YYYY-MM-DD format. |
| `role` | string | No | Role ID to assign to the user. Must be a valid role identifier in your organization. |
| `phone` | string | No | Phone number for the user. Should include country code (e.g., +1-202-555-0120). |
| `status` | string ("active" | "inactive") | No | User status options. |
| `user_id` | string | Yes | Unique identifier of the user to update. This is a required path parameter. |
| `time_format` | string | No | Preferred time format for the user. Common formats: HH:mm (24-hour) or hh:mm a (12-hour with AM/PM). |
| `country_locale` | string | No | Country locale setting for the user (e.g., en_US, en_GB). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Users

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `users` | array | Yes | Array of user objects to update. Each object must include the user's ID and the fields to modify. Maximum 100 users per request. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload Attachment

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | string | No | Local filesystem path of the file to upload. Provide either this or attachment_url. |
| `record_id` | string | Yes | Unique identifier of the record. |
| `attachment_url` | string | No | Public URL of the attachment to upload. Provide either this or file. |
| `module_api_name` | string ("Contacts" | "Pipelines" | "Accounts" | "Products" | "Tasks" | "Events" | "Notes") | Yes | API name of the module to which the attachment should be added. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload Organization Photo

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | The photo file to upload. Maximum size: 1 MB. Maximum resolution: 10 MP. Supported formats: image files (png, jpg, jpeg, gif, etc.). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload Record Photo

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | string | Yes | Local filesystem path of the photo/image file to upload. Photo must not exceed 10 MB in size or 10 megapixels in resolution. |
| `record_id` | string | Yes | Unique identifier of the record to upload the photo to. |
| `module_api_name` | string ("Contacts" | "Pipelines" | "Accounts" | "Products" | "Tasks" | "Events" | "Notes") | Yes | API name of the module containing the record (e.g., Contacts, Accounts). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upsert Records

**Slug:** `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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | array | Yes | List of JSON objects to upsert. Each object maps Field API names to values. Max 100 records per call. |
| `trigger` | array | No | Array of workflow triggers: 'workflow', 'approval', 'blueprint'. Default executes workflows; provide [] to skip workflow execution. |
| `module_api_name` | string ("Contacts" | "Accounts" | "Products") | Yes | 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 | No | 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. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |