Zoho Bigin
zoho_biginZoho Bigin is a simplified CRM solution from Zoho tailored for small businesses, focusing on pipeline tracking and relationship management
Acciones disponibles (12)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Add RecordsZOHO_BIGIN_ADD_RECORDSAcciónTool 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).
ZOHO_BIGIN_ADD_RECORDSAcciónTool 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).
Parámetros de entrada
dataobject[]ObligatorioList of JSON objects to insert. Each object maps Field API names to values. Max 100 records per call.
triggerstring[]Array of workflow triggers. Default ['workflow'] executes workflows; use [] to skip workflows.
module_api_namestringObligatorioenumThe API name of the module to insert into. Allowed: Contacts, Pipelines, Accounts, Products, Tasks, Events, Calls
ContactsPipelinesAccountsProductsTasksEventsCalls
Parámetros de salida
dataobject[]ObligatorioResults for each record insert request
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Add Tags to RecordsZOHO_BIGIN_ADD_TAGS_TO_RECORDSAcciónTool to add tags to a specific record in a module. use when you need to categorize or label a record after creation or update.
ZOHO_BIGIN_ADD_TAGS_TO_RECORDSAcciónTool to add tags to a specific record in a module. use when you need to categorize or label a record after creation or update.
Parámetros de entrada
tagsobject[]ObligatorioList of tag objects to add to the record
record_idstringObligatorioUnique identifier of the record to which tags will be added
over_writebooleanWhether to overwrite existing tags (default: false)
module_api_namestringObligatorioenumAPI name of the module where record resides
ContactsPipelinesCompaniesProductsTasksEventsCalls
Parámetros de salida
dataobject[]ObligatorioList of results for each record operation
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
wf_schedulerstringObligatorioIndicates if the workflow scheduler is enabled
success_countstringObligatorioNumber of successful tag additions
Create TagsZOHO_BIGIN_CREATE_TAGSAcciónTool to create tags for a module. use when you need to add new tags to a specific module in zoho bigin.
ZOHO_BIGIN_CREATE_TAGSAcciónTool to create tags for a module. use when you need to add new tags to a specific module in zoho bigin.
Parámetros de entrada
tagsobject[]ObligatorioList of tags to create
modulestringObligatorioenumAPI name of the module where tags will be added
ContactsPipelinesAccountsProductsTasksEventsCalls
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete AttachmentZOHO_BIGIN_DELETE_ATTACHMENTAcciónTool to delete an attachment from a record. use when you need to remove a file after confirming its record id and attachment id.
ZOHO_BIGIN_DELETE_ATTACHMENTAcciónTool to delete an attachment from a record. use when you need to remove a file after confirming its record id and attachment id.
Parámetros de entrada
record_idstringObligatorioUnique ID of the record from which to delete the attachment.
attachment_idstringObligatorioUnique ID of the attachment to be deleted.
module_api_namestringObligatorioenumAPI name of the module. Must be one of: Contacts, Pipelines, Accounts, Products, Tasks, Events, Notes.
ContactsPipelinesAccountsProductsTasksEventsNotes
Parámetros de salida
dataobject[]ObligatorioList containing the result of the delete operation.
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete RecordsZOHO_BIGIN_DELETE_RECORDSAcciónTool to delete records from a module. use when removing one or multiple records after confirming their ids.
ZOHO_BIGIN_DELETE_RECORDSAcciónTool to delete records from a module. use when removing one or multiple records after confirming their ids.
Parámetros de entrada
idsstring[]ObligatorioList of record IDs to delete
wf_triggerbooleanWhether to trigger workflow rules upon deletion
module_api_namestringObligatorioenumAPI name of the module to delete records from
ContactsPipelinesAccountsProductsTasksEventsCalls
Parámetros de salida
dataobject[]ObligatorioResults of each delete operation
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Download AttachmentZOHO_BIGIN_DOWNLOAD_ATTACHMENTAcciónTool 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.
ZOHO_BIGIN_DOWNLOAD_ATTACHMENTAcciónTool 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.
Parámetros de entrada
record_idstringObligatorioThe unique identifier of the record from which to download the attachment.
attachment_idstringObligatorioThe unique identifier of the attachment to download.
module_api_namestringObligatorioenumThe API name of the module containing the record. One of: Contacts, Pipelines, Accounts, Products, Tasks, Events, Notes.
ContactsPipelinesAccountsProductsTasksEventsNotes
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get AttachmentsZOHO_BIGIN_GET_ATTACHMENTSAcciónTool to retrieve attachments for a record. use when you need a paginated list of attachments for a given module record.
ZOHO_BIGIN_GET_ATTACHMENTSAcciónTool to retrieve attachments for a record. use when you need a paginated list of attachments for a given module record.
Parámetros de entrada
pageintegerPage number for pagination, must be >=1. Default is 1.
fieldsstringObligatorioComma-separated field API names to include in response. Up to 50 fields (e.g., File_Name,$file_id,Size,Parent_Id).
per_pageintegerRecords per page, must be >=1. Default is 200.
record_idstringObligatorioUnique identifier of the record.
module_api_namestringObligatorioenumAPI name of the module.
ContactsPipelinesAccountsProductsTasksEventsNotes
Parámetros de salida
dataobject[]ObligatorioList of attachment objects.
infoobjectObligatorioPagination metadata.
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Deleted RecordsZOHO_BIGIN_GET_DELETED_RECORDSAcciónTool 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).
ZOHO_BIGIN_GET_DELETED_RECORDSAcciónTool 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).
Parámetros de entrada
pageintegerPage number for pagination (starts at 1).
typestringenumType of deleted records to retrieve: all (default), recycle (in bin ≤60 days), permanent (deleted ≤120 days).
allrecyclepermanentper_pageintegerNumber of records per page (max 200).
module_api_namestringObligatorioenumAPI name of the module to retrieve deleted records from.
ContactsPipelinesAccountsProductsTasksEventsCalls
Parámetros de salida
dataobject[]ObligatorioList of deleted records matching the query.
infoobjectObligatorioPagination metadata for this response.
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get ModulesZOHO_BIGIN_GET_MODULESAcciónTool to retrieve a list of all modules. use when you need to discover which modules are available in bigin.
ZOHO_BIGIN_GET_MODULESAcciónTool to retrieve a list of all modules. use when you need to discover which modules are available in bigin.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get RecordsZOHO_BIGIN_GET_RECORDSAcciónTool to retrieve records from a bigin module. use when listing or querying module data with specific fields, sorting, filtering, and pagination.
ZOHO_BIGIN_GET_RECORDSAcciónTool to retrieve records from a bigin module. use when listing or querying module data with specific fields, sorting, filtering, and pagination.
Parámetros de entrada
cvidstringCustom view ID to filter by a saved custom view.
pageintegerPage index for pagination. Defaults to 1.
fieldsstringObligatorioComma-separated list of up to 50 field API names to retrieve.
sort_bystringField API name to sort by.
approvedstringenumFilter by approval status: 'true', 'false', or 'both'.
truefalsebothper_pageintegerNumber of records per page. Defaults to 200, max 200.
page_tokenstringToken from previous response for beyond-2000 retrieval.
sort_orderstringenumSort order: 'asc' or 'desc'. Applies when sort_by is provided.
ascdescmodule_api_namestringObligatorioenumAPI name of the Bigin module to retrieve records from.
ContactsPipelinesAccountsProductsTasksEventsCalls
Parámetros de salida
dataobject[]ObligatorioList of retrieved records.
infoobjectObligatorioPagination and metadata information.
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update RecordsZOHO_BIGIN_UPDATE_RECORDSAcciónTool 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.
ZOHO_BIGIN_UPDATE_RECORDSAcciónTool 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.
Parámetros de entrada
dataobject[]ObligatorioList of JSON objects to update. Each object must include 'id' and the fields to modify. Max 100 records per call.
triggerstring[]Array of workflow triggers. Default executes workflows; provide [] to skip workflow execution.
record_idstringOptional ID of a single record to update. If omitted, all IDs in `data` will be updated in bulk.
module_api_namestringObligatorioenumAPI name of the module to update records in. Allowed: Contacts, Pipelines, Accounts, Products, Tasks, Events, Calls
ContactsPipelinesAccountsProductsTasksEventsCalls
Parámetros de salida
dataobject[]ObligatorioResults for each record update request
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Upload AttachmentZOHO_BIGIN_UPLOAD_ATTACHMENTAcciónTool 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.
ZOHO_BIGIN_UPLOAD_ATTACHMENTAcciónTool 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.
Parámetros de entrada
filestringLocal filesystem path of the file to upload. Provide either this or attachment_url.
record_idstringObligatorioUnique identifier of the record.
attachment_urlstringPublic URL of the attachment to upload. Provide either this or file.
module_api_namestringObligatorioenumAPI name of the module to which the attachment should be added.
ContactsPipelinesAccountsProductsTasksEventsNotes
Parámetros de salida
dataobject[]ObligatorioList containing the upload results.
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not