delete_records
Delete Records
Permanently delete one or more records from any Bigin module by their IDs.
delete_records
Permanently delete one or more records from any Bigin module by their IDs.
remove_tags_from_record
Remove one or more tags from a specific record.
list_notes
Retrieve all notes associated with a specific record in any Bigin module. Returns note title, content, creation time, and owner information.
get_users
Retrieve users in the Bigin organization. Filter by user type such as active, deactive, confirmed, admin, or current user. Useful for finding user IDs to assign as record owners.
upsert_records
Insert or update records in a single call. If a record with matching duplicate check fields exists, it will be updated; otherwise, a new record is created. This is useful for syncing data from external systems.
get_record
Retrieve a single record by its ID from any Bigin module. Returns all fields for the specified record.
delete_note
Permanently delete a note by its ID.
get_modules
Retrieve the list of all available modules in the Bigin account, including their API names, display names, and capabilities (creatable, editable, deletable, etc.). Useful for discovering which modules are available.
list_tags
Retrieve all tags defined for a specific Bigin module.
create_tags
Create new tags in a Bigin module. Tags can be later added to records for categorization.
search_records
Search for records within a Bigin module using criteria-based queries, email addresses, phone numbers, or keywords. Provide exactly one search method per request.
get_custom_views
Retrieve the custom views defined for a specific Bigin module. Custom view IDs can be used to filter records when using the **Get Records** tool.
add_tags_to_records
Add one or more tags to one or more records in a Bigin module. Tags must already exist in the module or will be auto-created.
get_records
Retrieve records from any Bigin module. Supports filtering by custom view, field selection, sorting, and pagination. Use this to list contacts, companies, pipelines (deals), products, tasks, events, or calls.
get_module_layouts
Retrieve the layout definitions for a specific Bigin module. Layouts define which fields appear in which sections and their arrangement.
get_related_records
Retrieve records related to a specific record. For example, get all Notes for a Contact, or all Pipelines associated with an Account. Use the **Get Module Fields** tool or **Get Modules** tool to discover available relationships.
update_record
Update one or more existing records in any Bigin module. Provide the record ID and the fields to update. Only the specified fields will be modified; other fields remain unchanged.
create_record
Create one or more records in any Bigin module. Use field API names for the record data (e.g., Last_Name, Email, Phone for Contacts; Pipeline_Name, Amount for Pipelines). Retrieve field API names using the **Get Module Fields** tool if unsure.
get_module_fields
Retrieve the field definitions (metadata) for a specific Bigin module. Returns field API names, labels, data types, whether they are mandatory or read-only, picklist values, and more. Use this to understand the data structure before creating or updating records.
create_note
Add a note to a specific record in any Bigin module. Notes can include a title and content body.
Manage contacts, companies, deals, products, and activities in a lightweight CRM for small businesses. Create, read, update, delete, and search records across all modules. Manage related records, notes, and file attachments. Tag records, perform bulk read/write operations, and retrieve CRM metadata including fields, layouts, and custom views. Manage users, roles, and organization details. Subscribe to webhook notifications for real-time updates on record changes.
Common questions about connecting Zoho Bigin to AI agents with Metorial.