Skip to main content
Zoho Bigin logo
  • Category: crm
  • Auth: OAUTH2
  • Composio-managed OAuth available? Yes
  • Tools: 54
  • Triggers: 0
  • Slug: ZOHO_BIGIN
  • Version: 20261101_00

Tools

Slug: ZOHO_BIGIN_ADD_RECORDSTool 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

Input Parameters

array
required
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).
array
Array of workflow triggers. Default [‘workflow’] executes workflows; use [] to skip workflows.
string ("Contacts" | "Pipelines" | "Accounts" | "Products" | "Tasks" | "Events" | "Calls")
required
The API name of the module to insert into. Allowed: Contacts, Pipelines, Accounts, Products, Tasks, Events, Calls

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BIGIN_ADD_TAGS_TO_RECORDSAdd tags to a specific record in a module to categorize or label it. The optional overwrite setting can replace existing tags.

Input Parameters

array
required
List of tag objects to add to the record
string
required
Unique identifier of the record to which tags will be added
boolean
Whether to overwrite existing tags (default: false)
string ("Contacts" | "Pipelines" | "Accounts" | "Products" | "Tasks" | "Events" | "Calls")
required
API name of the module where record resides

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BIGIN_CREATE_BULK_READ_JOBTool 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

object
required
Query configuration specifying the module and optional filters for the bulk export.
object
Callback configuration for job completion notification.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BIGIN_CREATE_NOTESTool 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

array
required
Array of note objects to create. Each note must specify content, parent record, and module.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BIGIN_CREATE_RECORD_NOTESTool 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

array
required
List of note objects to create. Each note must have Note_Content; Note_Title is optional.
string
required
Unique identifier of the record to add notes to.
string ("Contacts" | "Pipelines" | "Accounts" | "Products" | "Tasks" | "Events" | "Calls")
required
API name of the module. Must be one of: Contacts, Pipelines, Accounts, Products, Tasks, Events, Calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BIGIN_CREATE_TAGSTool to create tags for a module. Use when you need to add new tags to a specific module in Zoho Bigin.

Input Parameters

array
required
List of tags to create
string ("Contacts" | "Pipelines" | "Accounts" | "Products" | "Tasks" | "Events" | "Calls")
required
API name of the module where tags will be added

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BIGIN_DELETE_ATTACHMENTTool 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

string
required
Unique ID of the record from which to delete the attachment.
string
required
Unique ID of the attachment to be deleted.
string ("Contacts" | "Pipelines" | "Accounts" | "Products" | "Tasks" | "Events" | "Notes")
required
API name of the module. Must be one of: Contacts, Pipelines, Accounts, Products, Tasks, Events, Notes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BIGIN_DELETE_NOTETool 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

string
required
Unique ID of the note to be deleted.
string
required
Unique ID of the record from which to delete the note.
string ("Contacts" | "Accounts" | "Products" | "Tasks" | "Events" | "Calls" | "Pipelines")
required
API name of the module. Must be one of: Contacts, Accounts, Products, Tasks, Events, Calls, Pipelines.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BIGIN_DELETE_NOTESTool to delete multiple notes from Zoho Bigin. Use when removing notes after confirming their IDs.

Input Parameters

string
required
Comma-separated note IDs to delete. Example: 410405000002264040,410405000002264025

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BIGIN_DELETE_RECORDDelete a specific record from a Zoho Bigin module by its ID. Workflow rules can be triggered upon deletion.

Input Parameters

string
required
Unique identifier of the record to delete
boolean
Whether to trigger workflow rules upon deletion. Defaults to true
string ("Contacts" | "Pipelines" | "Accounts" | "Products" | "Tasks" | "Events" | "Calls")
required
API name of the module to delete the record from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BIGIN_DELETE_RECORD_PHOTOTool to delete a profile photo from a record. Use when you need to remove the photo associated with a specific record.

Input Parameters

string
required
Unique ID of the record whose profile photo needs to be deleted.
string ("Contacts" | "Pipelines" | "Accounts" | "Products" | "Tasks" | "Events" | "Calls")
required
API name of the module. Must be one of: Contacts, Pipelines, Accounts, Products, Tasks, Events, Calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BIGIN_DELETE_RECORDSTool to delete records from a module. Use when removing one or multiple records after confirming their IDs.

Input Parameters

array
required
List of record IDs to delete
boolean
Whether to trigger workflow rules upon deletion
string ("Contacts" | "Pipelines" | "Accounts" | "Products" | "Tasks" | "Events" | "Calls")
required
API name of the module to delete records from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BIGIN_DISABLE_NOTIFICATIONSTool 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

string
required
Comma-separated list of unique notification channel IDs to be disabled. Example: 1000000068001,1000000068003

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BIGIN_DOWNLOAD_ATTACHMENTTool 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

string
required
The unique identifier of the record from which to download the attachment.
string
required
The unique identifier of the attachment to download.
string ("Contacts" | "Pipelines" | "Accounts" | "Products" | "Tasks" | "Events" | "Notes")
required
The API name of the module containing the record. One of: Contacts, Pipelines, Accounts, Products, Tasks, Events, Notes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BIGIN_DOWNLOAD_BULK_READ_RESULTTool 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

string
required
The unique identification of bulk read job, which is obtained from the response of the Create Bulk Read Job API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BIGIN_DOWNLOAD_RECORD_PHOTODownload the profile photo for a specific Contacts, Accounts, or Products record by its record ID. Returns the photo as a downloadable file; if the record has no profile photo, the tool reports that instead.

Input Parameters

string
required
The unique identifier of the record whose profile photo needs to be downloaded.
string ("Contacts" | "Accounts" | "Products")
required
The API name of the module containing the record. One of: Contacts, Accounts (Companies), Products.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BIGIN_ENABLE_NOTIFICATIONSTool 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

array
required
Array of notification configurations to enable. Maximum 100 channels can be configured per request

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BIGIN_GET_ALL_NOTESTool 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

integer
Page index for pagination. Defaults to 1.
string
required
Comma-separated list of up to 50 field API names to retrieve (e.g., Note_Title,Note_Content,Parent_Id).
integer
Number of records per page. Defaults to 200, max 200.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BIGIN_GET_ATTACHMENTSTool to retrieve attachments for a record. Use when you need a paginated list of attachments for a given module record.

Input Parameters

integer
Page number for pagination, must be >=1. Default is 1.
string
required
Comma-separated field API names to include in response. Up to 50 fields (e.g., File_Name,$file_id,Size,Parent_Id).
integer
Records per page, must be >=1. Default is 200.
string
required
Unique identifier of the record.
string ("Contacts" | "Pipelines" | "Accounts" | "Products" | "Tasks" | "Events" | "Notes")
required
API name of the module.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BIGIN_GET_BULK_READ_JOB_STATUSRetrieve the details and status of an earlier bulk read job, including the download URL and result metadata when available after completion.

Input Parameters

string
required
The unique identification of bulk read job, which is obtained from the response of the Create Bulk Read Job API

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BIGIN_GET_CUSTOM_VIEWTool 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

string
required
API name of the module (e.g., Contacts, Deals, Companies, Pipelines).
string
required
The unique ID of the custom view to retrieve metadata for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BIGIN_GET_CUSTOM_VIEWSTool 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

string ("Contacts" | "Pipelines" | "Accounts" | "Products" | "Tasks" | "Events" | "Calls" | "Associate_Products" | "Notes" | "Attachments")
required
The API name of the module to retrieve custom views for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BIGIN_GET_DELETED_RECORDSTool 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BIGIN_GET_FIELDSTool 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

string ("Contacts" | "Pipelines" | "Accounts" | "Products" | "Tasks" | "Events" | "Calls")
required
API name of the module to retrieve field metadata for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BIGIN_GET_LAYOUTTool 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

string ("Contacts" | "Pipelines" | "Accounts" | "Products" | "Tasks" | "Events" | "Calls" | "Associate_Products" | "Notes" | "Attachments")
required
The API name of the module for which to retrieve layout details.
string
required
The unique ID of the layout to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BIGIN_GET_LAYOUTSTool 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

string ("Contacts" | "Pipelines" | "Accounts" | "Products" | "Tasks" | "Events" | "Calls" | "Associate_Products" | "Notes" | "Attachments")
required
The API name of the module for which to retrieve layout metadata.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BIGIN_GET_MODULE_METADATATool 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

string ("Contacts" | "Pipelines" | "Accounts" | "Products" | "Tasks" | "Events" | "Calls" | "Associate_Products" | "Notes" | "Attachments")
required
API name of the module to retrieve metadata for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BIGIN_GET_MODULESTool to retrieve a list of all modules. Use when you need to discover which modules are available in Bigin.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BIGIN_GET_NOTIFICATION_DETAILSTool 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BIGIN_GET_ORGANIZATIONTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BIGIN_GET_PROFILESTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BIGIN_GET_RECORDTool 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

string
required
The unique ID of the record to retrieve.
string ("Contacts" | "Pipelines" | "Accounts" | "Products" | "Tasks" | "Events" | "Calls")
required
API name of the Bigin module to retrieve the record from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BIGIN_GET_RECORD_NOTESRetrieves notes associated with a specific module record, using a required selection of fields and optional pagination.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BIGIN_GET_RECORDSTool 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

string
Custom view ID to filter by a saved custom view. Cannot be used together with sort_by parameter.
integer
Page index for pagination (1-indexed). Cannot be used with page_token.
string
required
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.
string ("id" | "Created_Time" | "Modified_Time")
Field API name to sort by. Supported values: ‘id’, ‘Created_Time’, ‘Modified_Time’. Cannot be used together with cvid parameter.
string ("true" | "false" | "both")
Filter by approval status: ‘true’, ‘false’, or ‘both’.
integer
Number of records per page. Max 200.
string
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.
string ("asc" | "desc")
Sort order: ‘asc’ or ‘desc’. Applies when sort_by is provided.
string ("Contacts" | "Pipelines" | "Accounts" | "Products" | "Tasks" | "Events" | "Calls")
required
API name of the Bigin module to retrieve records from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BIGIN_GET_RECORDS_COUNTTool 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

string
Custom view ID to filter the count by a saved custom view. Use Custom Views Metadata API to get available custom view IDs.
string ("Contacts" | "Pipelines" | "Accounts" | "Products" | "Tasks" | "Events" | "Calls")
required
API name of the Bigin module to count records in.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BIGIN_GET_ROLESRetrieve the available roles and their properties in an organization, including role hierarchy and peer-sharing settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BIGIN_GET_TEAM_PIPELINE_RECORDSRetrieve deals or records from a specific Zoho Bigin team pipeline, with field selection, sorting, and pagination.

Input Parameters

integer
Page index for pagination. Defaults to 1.
string
required
Comma-separated list of field API names to retrieve (max 50 fields).
string ("id" | "Created_Time" | "Modified_Time")
Field to sort by. Supported values: ‘id’, ‘Created_Time’, ‘Modified_Time’.
integer
Number of records per page. Defaults to 200, max 200.
string ("asc" | "desc")
Sort order: ‘asc’ for ascending or ‘desc’ for descending.
string
required
The unique identification of a Team Pipeline.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BIGIN_GET_USERTool 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

string
required
The unique identification of the user to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BIGIN_GET_USERSTool 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BIGIN_SEARCH_RECORDSTool 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BIGIN_UPDATE_NOTETool 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

string
required
Unique identifier of the note to update
string
required
Unique identifier of the record that contains the note
string
Updated title for the note
string
Updated content/body text for the note
string ("Contacts" | "Pipelines" | "Accounts" | "Products" | "Tasks" | "Events" | "Calls")
required
API name of the module containing the record with the note. Allowed: Contacts, Pipelines, Accounts, Products, Tasks, Events, Calls

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BIGIN_UPDATE_NOTIFICATION_DETAILSTool 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

array
required
List of channels to update (max 100 per API call)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BIGIN_UPDATE_NOTIFICATION_INFOTool 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

array
required
List of watch configurations to update. Each must include channel_id and optional fields to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BIGIN_UPDATE_RECORDSTool 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BIGIN_UPDATE_USERTool 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BIGIN_UPDATE_USERSTool 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

array
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BIGIN_UPLOAD_ATTACHMENTTool 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

object
File to upload as an attachment. Provide either this or attachment_url.
string
required
Unique identifier of the record.
string
Public URL of the attachment to upload. Provide either this or file.
string ("Contacts" | "Pipelines" | "Accounts" | "Products" | "Tasks" | "Events" | "Notes")
required
API name of the module to which the attachment should be added.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BIGIN_UPLOAD_ORGANIZATION_PHOTOTool 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

object
required
The photo file to upload. Maximum size: 1 MB. Maximum resolution: 10 MP. Supported formats: image files (png, jpg, jpeg, gif, etc.).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BIGIN_UPLOAD_RECORD_PHOTOTool 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

object
required
Photo/image file to upload. Photo must not exceed 10 MB in size or 10 megapixels in resolution.
string
required
Unique identifier of the record to upload the photo to.
string ("Contacts" | "Pipelines" | "Accounts" | "Products" | "Tasks" | "Events" | "Notes")
required
API name of the module containing the record (e.g., Contacts, Accounts).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_BIGIN_UPSERT_RECORDSInsert or update Contacts, Accounts, or Products records based on unique field values. Updates existing records if duplicates are found, otherwise inserts new records, allowing data to be synced without checking for existing records first.

Input Parameters

array
required
List of JSON objects to upsert. Each object maps Field API names to values. Max 100 records per call.
array
Array of workflow triggers: ‘workflow’, ‘approval’, ‘blueprint’. Default executes workflows; provide [] to skip workflow execution.
string ("Contacts" | "Accounts" | "Products")
required
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.
array
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not