Zoho Bigin
API integration

list_all_zoho_bigin_users

A user is someone who has access to an organization in Bigin. Use this endpoint to get all users in the Zoho Bigin account.

get_single_zoho_bigin_user_by_id

Use this endpoint to get a single user in the Zoho Bigin account. It always requires the ID to fetch.

delete_a_zoho_bigin_user_by_id

Use this endpoint to delete a single user in the Zoho Bigin account. It always requires the ID to delete a user.

zoho_bigin_users_bulk_update

Update details of multiple Bigin users in a single request. Returns per-user results with code, details (including the user's id), message, and status. Required: users array where each item includes id. Deactivated users cannot be updated, and the primary user cannot be deactivated directly.

create_a_zoho_bigin_user

Add a new user to a Bigin organization. Returns the operation result with code, details (including the new user's id), message, and status. Required: first_name, last_name, email, role, and profile. Only one user can be added per request.

zoho_bigin_users_update_by_id

Update the details of a specific Bigin user by user_id. Returns the operation result with code, details (including the user's id), message, and status. Required: user_id and id. Deactivated users cannot be updated, and only your own time zone can be changed.

list_all_zoho_bigin_current_organization

An organization in Bigin represents a company. Use this endpoint to get the current company information in the Zoho Bigin account.

list_all_zoho_bigin_me

Use this endpoint to get the information about the currently authenticated user in the Zoho Bigin account.

list_all_zoho_bigin_roles

In Zoho Bigin, each organization has a defined set of roles that determine data access based on a hierarchy. These roles are assigned to users according to their responsibilities. Use this endpoint to retrieve a list of all the roles available in your organization.

list_all_zoho_bigin_profiles

In Bigin, profiles determine user permissions and control the actions users can perform within the application. Each user in the Bigin setup is assigned a profile that defines their level of access to organizational data. Use this endpoint to retrieve a list of all the profiles available in your organization.

zoho_bigin_attachments_bulk_delete

Delete an attachment attached to a record in zohobigin. Returns: data.id of the deleted attachment. Required: module_api_name, record_id, attachment_id.

create_a_zoho_bigin_attachment

Upload an attachment to a record in zohobigin by providing a file or an attachment URL. Returns: code, details, message, status. Required: module_api_name, record_id. Supply either file or attachmentUrl.

zoho_bigin_attachments_download

Download an attachment attached to a record in zohobigin. Returns the raw attachment file content (binary) rather than a JSON object. Required: module_api_name, record_id, attachment_id.

list_all_zoho_bigin_attachments

List attachments associated with a record in zohobigin. Returns: File_Name, Size, Parent_Id, id, $file_id. Required: module_api_name, record_id, fields (comma-separated field API names, up to 50).

create_a_zoho_bigin_note

Create new notes in zohobigin for one or more records. Returns per-note results with code, message, status, and details including id, Created_By, Modified_By, Created_Time, and Modified_Time. Required: data (with Note_Content); the first note also needs Parent_Id and se_module.

zoho_bigin_notes_delete_many

Delete one or more notes in zohobigin by note ID. Returns: code, message, status, details. Required: ids (comma-separated note IDs, max 100).

get_single_zoho_bigin_note_by_id

Get a specific note in zohobigin by id. Returns the list of note records available to the integration. Required: id.

list_all_zoho_bigin_notes

List notes associated with the records in zohobigin. Returns the list of note records available to the integration. Supports page and per_page paging, e.g. per_page up to 200 with a default of 200 and a default page index of 1.

zoho_bigin_notes_create_for_record

Create a new note attached to a specific record in zohobigin. Returns per-note results with code, message, status, and details including id, Created_By, Modified_By, Created_Time, and Modified_Time. Required: module_api_name, record_id, data (with Note_Content).

delete_a_zoho_bigin_note_by_id

Delete a specific note in zohobigin by id. Returns data with per-note entries containing code, details.id, message, and status. Required: id.

zoho_bigin_notes_delete_for_record

Delete a specific note attached to a record in zohobigin. Returns data with per-note entries containing code, details.id, message, and status. Required: module_api_name, record_id, note_id.

zoho_bigin_notes_update_for_record

Update an existing note attached to a record in zohobigin. Returns: code, details, message, status. Required: module_api_name, record_id, note_id, and a data body array whose items take optional Note_Title and Note_Content.

get_single_zoho_bigin_organization_by_id

Get the details of your zohobigin organization, including company, currency, time zone, and logo information. Returns: id, company_name, alias, domain_name, description, website, time_zone, currency, currency_symbol, currency_locale, iso_code, mc_status, country, country_code, city, street, state, zip, fax, mobile, phone, primary_email, employee_count, photo_id, primary_zuid, zgid, zia_portal_id,…

zoho_bigin_organization_upload_photo

Upload a brand logo or image for your zohobigin organization, or use it to replace the existing organization photo. Returns the upload result: code, message, status, and details. Required: file (multipart/form-data, max 1 MB).

list_all_zoho_bigin_profiles_settings

List the profiles available in your zohobigin organization, including the default Administrator and Standard profiles plus any custom profiles. Returns each profile's id, name, display_label, description, type, custom flag, created_time, modified_time, created_by, and modified_by.

zoho_bigin_record_photo_bulk_delete

Delete the profile photo associated with a record in Bigin. Returns: code, details, message, status. Required: module_api_name (Contacts, Accounts, or Products) and record_id.

create_a_zoho_bigin_record_photo

Upload a profile photo for a record in Bigin by sending the image file as a multipart form upload. Returns: code, details, message, status. Required: module_api_name (Contacts, Accounts, or Products), record_id, and file. Photo must be within 10 MB and 10 MP.

get_single_zoho_bigin_record_photo_by_id

Download the profile photo of a record in Bigin. Returns the raw photo file itself rather than a JSON object. Required: id and module_api_name (Contacts, Accounts, or Products).

zoho_bigin_records_bulk_delete

Delete up to 100 records from a zohobigin module. Returns a data array of per-record results with code, message ("record deleted"), status, and details.id. Required: module_api_name, ids.

zoho_bigin_records_bulk_update

Update up to 100 existing records in a zohobigin module in a single call. Returns per-record results with code, details (id, Created_Time, Modified_Time, Created_By, Modified_By), message ("record updated"), and status. Required: module_api_name and data items with id.

zoho_bigin_records_change_owner

Change the owner of up to 500 records in a zohobigin module. Returns a data array of per-record results with code, message ("owner is successfully updated"), status, and details.id. Required: module_api_name, ids, and owner (with owner.id).

zoho_bigin_records_change_owner_by_id

Change the owner of a specific record in a Bigin module by id. Returns a data array with per-record code, status, message, and the affected record id in details. Required: module_api_name, record_id, and owner.id; pass notify to email the new owner.

zoho_bigin_records_count

Get the total count of records available in a specified Bigin module. Returns: select_query. Required: module_api_name.

create_a_zoho_bigin_record

Create new records in a Bigin module selected by module_api_name. Returns per-record results including code, status, message, and details with the new record id. Required: module_api_name plus the module's system-defined mandatory fields (e.g., Last_Name for Contacts, Deal_Name/Sub_Pipeline/Stage for Pipelines). Max 100 records per call.

zoho_bigin_records_delete_by_id

Delete a specific record from a Bigin module by record id. Returns per-record results including code, status, message, and details with the deleted record id. Required: module_api_name and record_id. By default, workflows related to the delete are executed; set wf_trigger to false to skip them.

get_single_zoho_bigin_record_by_id

Get a single record from a Bigin module by its record id. Returns the full record including id, Last_Name, First_Name, Email, Owner, Created_Time, and Modified_Time (fields vary by module). Required: module_api_name and id.

list_all_zoho_bigin_records

List records available in a Bigin module selected by module_api_name. Returns records with fields such as id, Last_Name, First_Name, Email, Owner, and Created_Time; the fields parameter (up to 50 field API names) controls which fields are returned. Required: module_api_name and fields.

zoho_bigin_records_list_deleted

List records deleted from a Bigin module selected by module_api_name, covering recycle-bin and permanently deleted records. Returns: id, display_name, deleted_by, created_by, deleted_time. Required: module_api_name. Recycle-bin records are available for 60 days and permanently deleted records for 120 days after deletion.

zoho_bigin_records_search

Search Bigin records in a module by criteria, email, phone, or a keyword — supply exactly one search parameter per call. Returns matching record objects with id, Owner, Full_Name, Email, Created_Time, and Modified_Time. Required: module_api_name.

zoho_bigin_records_update_by_id

Update a specific Bigin record in a module by its id, passing the fields to change in a data array. Returns the update result per record: status, message, code, and details with the updated record's id, Created_Time, and Modified_Time. Required: module_api_name, record_id, and data. Duplicate checks run on unique fields.

zoho_bigin_records_upsert

Insert or update a Bigin record in a module with a single call, matching on system-defined and user-defined unique fields to prevent duplicates. Returns per-record results with action (insert or update), status, message, code, duplicate_field, and details including the record id. Required: module_api_name and a data array. Max 100 records per call.

zoho_bigin_related_records_bulk_update

Update or relate up to 100 related list records to a parent record in zohobigin (Bigin) in a single call, setting related-module field values per record. Returns per-record results with code, details.id, message, and status. Required: module_api_name, record_id, related_list_api_name, data. Each data item must include the related record's id. Max 100 related records per call.

zoho_bigin_related_records_delink_by_related_id

Delink a specific related list record from its parent record in zohobigin (Bigin), removing the association without deleting the record itself. Returns data, an array of per-record results each with code, details.id, message, and status. Required: module_api_name, record_id, related_list_api_name, related_record_id.

zoho_bigin_related_records_delink_many

Delink up to 100 related list records from a parent record in zohobigin (Bigin) in one call by passing comma-separated ids. Returns data, an array of per-record results each with code, details.id, message, and status. Required: module_api_name, record_id, related_list_api_name, ids. Max 100 related record IDs per request.

list_all_zoho_bigin_related_records

List the related list records associated with a record in zohobigin (Bigin). Returns each related record's id and field values such as Deal_Name, Stage, Sub_Pipeline, and Pipeline (fields vary by related list). Required: module_api_name, record_id, related_list_api_name, fields. Max 200 records per page.

zoho_bigin_related_records_update_by_related_id

Update the relation between a parent record and a specific related list record in zohobigin (Bigin), setting related-module field values on that relation. Returns per-record results with code, details.id, message, and status. Required: module_api_name, record_id, related_list_api_name, related_record_id, data. Each data item must include the related record's id.

list_all_zoho_bigin_roles_settings

List all roles available in your zohobigin organization, reflecting the role hierarchy used for data access levels. Returns: id, name, display_label, description, share_with_peers, reporting_to, forecast_manager. This endpoint takes no query parameters.

zoho_bigin_tags_add_to_record

Add tags to a specific record in a zohobigin module. Returns per-record results including status, code, message, and details with the record id and applied tags. Required: module_api_name, record_id, tags, ids.

zoho_bigin_tags_add_to_records

Add one or more tags to multiple records in a zohobigin module. Returns per-record results including status, code, message, and details with the record id and applied tags. Required: module_api_name, tags, ids.

zoho_bigin_tags_bulk_update

Update one or more existing tags in a zohobigin module. Returns per-tag results including status, code, message, and details with id, created_time, modified_time, created_by, modified_by, and color_code. Required: module, and a tags list where each item has id and name.

create_a_zoho_bigin_tag

Create one or more new tags for a zohobigin module. Returns per-tag results including status, code, message, and details with id, created_time, modified_time, created_by, modified_by, and color_code. Required: module, and a tags list where each item has a name.

delete_a_zoho_bigin_tag_by_id

Delete an existing tag in zohobigin by id. Returns a tags array with the deletion result including status, code, message, and details.id. Required: id.

list_all_zoho_bigin_tags

List all tags configured for a module in Bigin. Returns tags with id, name, color_code, created_time, modified_time, created_by, and modified_by. Required: module (the module API name, e.g. Contacts, Pipelines, Accounts).

zoho_bigin_tags_record_count

Get the number of records associated with a specific tag in Bigin. Returns: count.g. 28 for a Pipelines tag. Required: tag_id and module (the module API name: Contacts, Pipelines, Accounts, Products, Tasks, Events, or Calls).

zoho_bigin_tags_remove_from_record

Remove one or more tags from a specific record in a Bigin module. Returns per-record results with code, status, message, and details containing the record id and tags. Required: module_api_name, record_id, tag_names.

zoho_bigin_tags_remove_from_records

Remove one or more tags from multiple records in a Bigin module. Returns per-record results with code, status, message, and details containing the record id and tags. Required: module_api_name, ids, tag_names.

zoho_bigin_tags_update_by_id

Update an existing tag by id in Bigin. Returns per-tag results with code, status, message, and details containing id, created_time, modified_time, created_by, modified_by, and color_code. Required: tag_id, module, and a tags body where each item has id and name.

zoho_bigin_team_pipeline_records_list_team_pipeline_records

List records from a Team Pipeline in Bigin. Returns: id, Deal_Name, Stage, Closing_Date, Pipeline. Required: pipeline_id and fields (up to 50 comma-separated field API names). Max 200 records per call.

team_pipeline_records_list_team_pipeline_records_for_contact

List Team Pipeline records associated with a specific contact in Bigin. Returns: id, Deal_Name, Stage, Sub_Pipeline, Closing_Date, Contact_Role. Required: contact_id and pipeline_id.

delete_a_zoho_bigin_users_user_by_id

Delete a user from the Zoho Bigin organization by id. Returns a users array whose entry confirms the deletion with code, message, and status. Required: id (the user's unique id from the Get Users API). Only one user can be deleted per request, and the organization's primary user cannot be deleted directly.

list_all_zoho_bigin_users_users

List users who have access to a Bigin organization via zohobigin. Returns: id, email, first_name, last_name, full_name, alias, status, category, confirm, role, profile, created_by, Modified_By, created_time, Modified_Time, country, city, street, state, country_locale, zip, customize_info, signature, sort_order_preference, name_format, language, microsoft, locale, personal_account, Isonline,…

create_a_zoho_bigin_bulk_read

Create a bulk read job in zohobigin to export records from a Bigin module as CSV, or as ICS for Events/Meetings; the target module is set via query.module. Returns: status, code, message, details. The job runs asynchronously — check job status and download the result using the returned job id; up to 200,000 records are exported per page.

zoho_bigin_bulk_read_download_result

Download the result of a zohobigin bulk read job. Returns the exported file as a .zip archive containing the CSV (or ICS for Events/Meetings) export. Required: job_id.

get_single_zoho_bigin_bulk_read_by_id

Get the status and details of a zohobigin bulk read job by id. Returns: id, operation, state, query, result, created_by, created_time. Required: id.

create_a_zoho_bigin_bulk_write

Create a bulk write job in Zoho Bigin to asynchronously insert, update, or upsert records from an uploaded CSV file. Returns: status, code, message, details. Required: operation (insert, update, or upsert) plus resource entries with type, module, file_id, ignore_empty, and find_by (find_by mandatory for update/upsert).

zoho_bigin_bulk_write_download_result

Download the result of a bulk write job in Zoho Bigin as a ZIP archive containing a CSV report with the first three mapped columns plus ID, Status, and Errors columns. Returns a binary file download rather than JSON. Required: job_id, obtained from the download_url in the job details response.

get_single_zoho_bigin_bulk_write_by_id

Get the details of a bulk write job in Zoho Bigin by id. Returns: status, character_encoding, id, operation, created_time, created_by, result, resource.download_url once the job completes. Required: id.

zoho_bigin_bulk_write_upload_file

Upload a CSV file in ZIP format to Zoho Bigin for use in a bulk write job. Returns: status, code, message, details. Required: file. Pass the returned file_id when creating the bulk write job.

zoho_bigin_coql_query

Execute a COQL SELECT query against Bigin modules to retrieve matching records. Returns one record per match with the fields named in the SELECT clause plus id (e.g. Deal_Name, Product_Name, Created_Time); the returned fields vary with the query. Required: select_query.

get_single_zoho_bigin_custom_view_by_id

Get the metadata of a specific custom view in a zohobigin module by id. Returns: id, name, display_value, system_name, system_defined, access_type, category, criteria, fields, sort_by, sort_order, created_by, modified_by, shared_to, created_time, modified_time, last_accessed_time, locked, favorite. Required: id, module.

list_all_zoho_bigin_custom_views

List the custom views metadata configured for a module in zohobigin. Returns: id, name, display_value, system_name, system_defined, access_type, category, criteria, fields, sort_by, sort_order, created_by, modified_by, shared_to, created_time, modified_time, last_accessed_time, locked, favorite. Required: module.

zoho_bigin_email_list_from_addresses

List the from-addresses configured in zohobigin for sending emails, so you can pick a valid sender when calling send. Returns: display_value, type, email.

zoho_bigin_email_send

Send an email from zohobigin to the email addresses associated with a record. Returns the send result including code, details (containing the scheduled message_id), message, and status. Required: module_api_name, record_id, and data. Supported modules: Contacts, Pipelines, and Accounts (Companies).

get_single_zoho_bigin_fields_meta_by_id

Get the metadata of a specific field in a Bigin module by id. Returns: id, api_name, field_label, display_label, data_type, json_type, webhook, colour_code_enabled_by_system, tooltip, field_read_only, read_only, association_details, businesscard_supported, multi_module_lookup, created_time, filterable, visible, profiles, view_type, subform, separator, searchable, external, unique,…

list_all_zoho_bigin_fields_meta

List the metadata of all fields in a Bigin module. Returns: id, api_name, field_label, display_label, data_type, json_type, webhook, colour_code_enabled_by_system, tooltip, field_read_only, read_only, association_details, businesscard_supported, multi_module_lookup, created_time, filterable, visible, profiles, view_type, subform, separator, searchable, external, unique, enable_colour_code,…

create_a_zoho_bigin_file

Upload one or more files to zohobigin using a multipart/form-data request; each file must not exceed 20 Mb. Returns the per-file upload result with code, details (file name and encrypted id), message, and status — the encrypted id is required to attach the file to a record. Required: file.

get_single_zoho_bigin_file_by_id

Retrieve a file from zohobigin using its encrypted id, as received when the file was uploaded. Returns the file's raw content as a binary stream; the response body is content-type-specific rather than a fixed field set. Required: id.

get_single_zoho_bigin_layout_by_id

Get the metadata of a single layout in Zoho Bigin by id. Returns the layout's id, name, display_label, status, sections with their fields, and associated profiles. Required: id, module (the module's API name, e.g. Pipelines).

list_all_zoho_bigin_layouts

List the layout metadata for a module in Zoho Bigin. Returns each layout's id, name, display_label, status, sections with their fields, and associated profiles. Required: module (the module's API name, e.g. Contacts, Pipelines, Accounts).

get_single_zoho_bigin_module_by_id

Get the metadata of a specific module in Bigin (zohobigin) by its API name. Returns the module's id, api_name, module_name, singular_label, plural_label, visibility, profiles, custom_view, and capability flags such as creatable and editable. Required: module_api_name (e.g. Pipelines, Contacts, Accounts).

list_all_zoho_bigin_modules

List all modules available in a Bigin (zohobigin) organization. Returns each module's id, api_name, module_name, singular_label, plural_label, visibility, profiles, and capability flags such as creatable, editable, and deletable. Use each module's api_name in subsequent record operations.

zoho_bigin_notifications_bulk_delete

Disable notifications in zohobigin by deleting the specified channels and the notifications enabled for them. Returns the watch envelope: one result per channel with code, message, status, and details (resource_uri, resource_id, channel_id). Required: channel_ids (comma-separated list).

zoho_bigin_notifications_bulk_update

Update notification details in zohobigin, overwriting the details set while enabling each channel; up to 100 channels per call. Returns per-channel results with code, message, status, and details.events (channel_id, resource_name, resource_uri, resource_id, channel_expiry). Required: watch array with channel_id and notify_url per channel.

create_a_zoho_bigin_notification

Enable notification channels in zohobigin that send webhook alerts when record actions occur in modules; up to 100 channels per call. Returns per-channel results with code, message, status, and details.events (channel_id, resource_name, resource_uri, resource_id, channel_expiry). Required: watch.

list_all_zoho_bigin_notifications

List all user-enabled notification channels in zohobigin, optionally filtered by channel_id or module. Returns each subscription with channel_id, notify_url, events, resource_name, resource_uri, resource_id, channel_expiry, and token. module accepts Contacts, Pipelines, Accounts, Products, Tasks, Events, or Calls.

zoho_bigin_notifications_partial_update

Update specific details of notification channels in zohobigin while retaining existing settings; supplied events are appended to the channel's current events. Up to 100 channels per call. Returns per-channel results with code, message, status, and details.events (channel_id, resource_name, resource_uri, resource_id, channel_expiry). Required: watch array with channel_id per channel.

list_all_zoho_bigin_related_lists_meta

List the related lists metadata of a module in zohobigin (Bigin). Returns each related list's id, name, api_name, display_label, type, sequence_number, module, and href. Required: module — one of the API names Contacts, Pipelines, Accounts, Products, Tasks, Events, Calls.