Reference

Get Profiles

Retrieve all available user profiles and their properties in your Zoho Bigin organization. Use this to discover which profiles exist and understand their configurations.

Get Roles

Retrieve all available roles in your Zoho Bigin organization to understand user permissions and role hierarchy. Use this to discover what roles exist and their properties before assigning them to team members.

Get User

Retrieve detailed information about a specific user in your Zoho Bigin CRM by their ID, including their profile data and account details. This helps you quickly access user information for verification, communication, or account management purposes.

Get Users

Retrieve all users in your Zoho Bigin organization with the ability to filter by user status, such as active, inactive, or admin users. Use this to view team members and manage access across your CRM.

Update User

Modify an existing user's profile details like contact information, role, or status in your CRM system. This keeps your team directory current and ensures users have the correct permissions and preferences.

Update Users

Modify details for multiple users in your Zoho Bigin organization, such as contact information, roles, and status in a single action. This helps you keep your team information current and manage user permissions efficiently.

Delete Attachment

Remove files that are no longer needed from your CRM records to keep your data clean and organized.

Download Attachment

Retrieves the binary file content of an attachment stored in a Zoho Bigin record, allowing you to access and work with files directly without manually downloading them through the interface.

Get Attachments

Retrieve all files and documents attached to a specific contact, deal, or other record in your CRM, with automatic pagination for easy access to your complete file history.

Create Bulk Read Job

Initiate an asynchronous bulk export of records from your CRM when dealing with large datasets that would exceed normal limits, receiving a job ID to track progress and retrieve results later.

Download Bulk Read Result

Downloads the results of a completed bulk read job as a ZIP file containing your exported CRM data in CSV or ICS format, allowing you to access and use large datasets from Zoho Bigin.

Get Bulk Read Job Status

Check the status and progress of a bulk data export job you've initiated, and retrieve the downloaded results once the job completes.

Create Record Notes

Add detailed notes to any record in your CRM to capture important information, follow-up items, or conversation details that team members need to know about.

Create Notes

Add detailed notes directly to your contacts, accounts, deals, and other records in Zoho Bigin to keep all important information organized and accessible in one place.

Delete Note

Removes a note from a customer, deal, or contact record in your CRM when it's no longer needed or was created in error. This helps keep your records clean and up-to-date.

Delete Notes

Remove one or more notes from your Zoho Bigin CRM after you've confirmed which ones to delete, helping you keep your customer records clean and organized.

Get All Notes

Retrieve all notes linked to your CRM records with pagination support, allowing you to access up to 200 notes per request to review communications and activity history.

Get Record Notes

Retrieve all notes attached to a specific customer, deal, or contact record in your CRM. This helps you quickly access important communication history and context without manually searching through records.

Update Note

Modify the title or content of an existing note attached to a customer, deal, or other record in your CRM. This helps you keep your contact information accurate and up-to-date as business relationships evolve.

Disable Notifications

Stop receiving instant notifications from specific channels in your CRM so you can focus on work without constant interruptions. Useful when you need to temporarily silence alerts from certain communication channels.

Enable Notifications

Activates real-time webhook notifications for your Bigin CRM so you can instantly detect when records are created, modified, or deleted across your sales modules.

Get Notification Details

Retrieve information about your active notification settings and configured channels in Zoho Bigin. This helps you verify which modules are sending alerts and ensure you're receiving critical business updates.

Update Notification Details

Modify existing notification channels in Zoho Bigin to change webhook URLs, monitored events, authentication tokens, or expiration settings without losing your notification configuration.

Update Notification Info

Modify notification settings like events, expiry times, tokens, or webhook URLs while preserving other notification data. This helps you keep your CRM alerts and integrations synchronized with your current business processes.

Get Organization

Fetches your organization's core settings including name, ID, currency, and timezone so you can reference your account configuration programmatically. This is useful for verifying account details or using organization data in your workflows.

Delete Record Photo

Removes a profile photo from a contact or record in your CRM, helping you keep record images current and accurate. Use this when you need to update outdated photos or remove incorrect images.

Download Record Photo

Retrieve the profile photo attached to a specific customer, contact, or lead record in your CRM database. This is useful when you need to access visual profile information for communications, reports, or integration with other business tools.

Add Records

Quickly add new records like contacts, tasks, events, or calls directly into your Zoho Bigin CRM. This operation helps you programmatically populate your CRM with important business data to keep your customer information organized and up-to-date.

Delete Records

Remove one or multiple records from your CRM module when they're no longer needed, such as duplicate contacts, outdated deals, or closed opportunities.

Get Record

Retrieve complete details of a single record from your Zoho Bigin CRM by its ID, allowing you to access all stored information about a contact, deal, or other business entity.

Get Records

Retrieve a list of records from a Bigin module with support for filtering, sorting, and pagination to access the data you need. Use this to pull customer information, leads, deals, or other module data for reporting or further processing.

Update Records

Modify existing records in your Zoho Bigin CRM by updating specific fields in one or multiple contacts, deals, or other data entries at once.

Delete Record

Remove a specific record from your Zoho Bigin database when you no longer need it, such as closing out a lead or contact that's no longer relevant to your business.

Delink Related Records

Remove the association between two records in your CRM without deleting either record, allowing you to reorganize relationships as your business needs change.

Get Deleted Records

Retrieve a list of deleted records from any module to audit, recover, or permanently remove data that was recently deleted within your retention window.

Get Records Count

Quickly retrieve the total number of records in a Zoho Bigin module, with optional filtering by custom views to get counts for specific record segments.

Get Related Records

Retrieve all related records such as notes, attachments, products, or activities linked to a specific contact, deal, or account in your CRM. This helps you get a complete view of all interactions and information associated with a customer or business opportunity.

Get Team Pipeline Records

Retrieve deals and records from a team's pipeline in Zoho Bigin, with options to filter and sort results for better organization and visibility.

Search Records

Find specific customer, contact, or deal records in Zoho Bigin by searching across fields like email, phone, name, or custom criteria to quickly locate the information you need.

Update Related Records

Modify linked records associated with a specific contact, account, or other module entry, such as updating notes, activities, or related items in bulk.

Get Fields

Retrieve the list of all available fields in a Bigin module along with their data types, validation rules, and picklist options. This helps you understand the structure of your CRM data before creating records or building automations.

Get Layout

Retrieve the complete configuration and field structure of a specific layout in your CRM, including all sections, fields, and their display settings.

Get Layouts

Retrieves all available layouts for a specific CRM module, showing you how fields are organized and configured. This helps you understand the structure of your customer data and customize views for your team's needs.

Get Module Metadata

Retrieve detailed configuration and structure information about a specific module in your Zoho Bigin CRM, including field definitions, permissions, and available features.

Get Modules

Retrieves all available modules in your Zoho Bigin CRM instance, helping you understand what data types and features are accessible in your system.

Get Related Lists Metadata

Retrieves metadata about all related lists available for a specific CRM module, helping you understand what associated records you can access and manage. This is useful for discovering which relationships are configured in your CRM system.

Add Tags to Records

Attach labels to your CRM records to organize and categorize them by type, priority, or status. This helps you quickly filter and manage records based on meaningful groupings.

Create Tags

Organize and categorize your CRM data by creating custom tags for contacts, deals, or other modules to improve tracking and filtering.

Get Custom View

Retrieves the detailed configuration and settings of a custom view in your CRM module, including its filters, field selections, and display criteria. Use this to understand how a specific custom view is set up or to programmatically access its structure for automation purposes.

Get Custom Views

Retrieve all custom views available for a specific module in your Bigin CRM, helping you discover and work with saved filters and views that organize your data.

Upload Attachment

Tool to upload an attachment to a record.

Upload Organization Photo

Tool to upload or update the brand logo or image for the current organization.

Upload Record Photo

Tool to upload a photo/image to a specific record (e.g., contact photo).

Upsert Records

Tool to insert or update records in a module based on unique field values.