Skip to main content

Zoho Bigin

Zoho Bigin is a pipeline-centric CRM built for small and micro businesses, helping teams manage contacts, companies, deals, tasks, and activities in one place. The Bigin REST API exposes these CRM records so they can be read from and written to programmatically. Nexla connects to the Bigin API using OAuth 2.0, letting you ingest records such as contacts, companies, and pipelines, and push new or updated records back into Bigin.

Zoho Bigin icon

Power end-to-end data operations for your Zoho Bigin API with Nexla. Our bi-directional Zoho Bigin connector is purpose-built for Zoho Bigin, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Zoho Bigin or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Zoho Bigin workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites​

Zoho Bigin uses OAuth 2.0 (authorization code). Nexla runs the sign-in flow for you, but it needs a client that you register in the Zoho API Console. Complete the following steps before creating a credential in Nexla.

  1. Sign in to the Zoho API Console with a Zoho account that can access your Bigin organization.

  2. Click Add Client (or Get Started if this is your first client) and choose Server-based Applications.

  3. Enter a Client Name and a Homepage URL, and set the Authorized Redirect URIs to https://dataops.nexla.io/nexla-api/oauth/callback. The redirect URI must match exactly, or Zoho rejects the sign-in.

  4. Click Create. Zoho shows the client's Client ID and Client Secret; copy both, and keep the secret confidential.

  5. Note your Zoho data center. The credential's defaults are for the US data center (accounts.zoho.com and https://www.zohoapis.com/bigin/v2). Bigin is also served from the EU, India, Australia, China, Japan, Saudi Arabia, and Canada data centers, each with its own domains.

For details, see Bigin's guides to registering a client, OAuth scopes, and multiple data centers.

Authenticate​

Credentials required​

An OAuth authentication flow where users must authorize an application to access their data

FieldRequiredSecretDescription
Authorization URLNoNoThe URL endpoint where users authenticate and authorize access
Client IDYesYesA unique public identifier assigned to your application
Access ScopeNoNoComma-separated Zoho OAuth scopes. The default covers records, settings, users and organization reads.
Token URLNoNoThe URL endpoint where authorization codes are exchanged for access tokens
Client SecretNoYesA private key used to authenticate your application when requesting tokens
Base URLYesNoBigin API base URL for your data center, e.g. https://www.zohoapis.com/bigin/v2 (US) or https://www.zohoapis.eu/bigin/v2 (EU).

The default Access Scope, ZohoBigin.modules.ALL,ZohoBigin.settings.ALL,ZohoBigin.users.READ,ZohoBigin.org.READ, covers reading and writing records, reading and changing settings such as tags, and reading users and organization details. Zoho expects scopes as a comma-separated list. If you narrow the scopes, templates that need an omitted scope will fail.

The Authorization URL, Token URL, and Base URL default to the US data center (https://accounts.zoho.com/oauth/v2/auth, https://accounts.zoho.com/oauth/v2/token, and https://www.zohoapis.com/bigin/v2). For an account in another data center, change all three to that data center's domains, for example https://accounts.zoho.eu/oauth/v2/auth, https://accounts.zoho.eu/oauth/v2/token, and https://www.zohoapis.eu/bigin/v2 for the EU. Bigin's API domains are www.zohoapis.com, .eu, .in, .com.au, .com.cn, .jp, .sa, and .ca; see multiple data centers for the matching accounts domains.

Create a credential in Nexla​

  1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

  2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

  3. Enter the Client ID and Client Secret of your Zoho API Console client.

  4. Leave the Base URL, Authorization URL, and Token URL at their defaults for a US account, or change them to your data center as described above.

  5. Optionally, adjust the Access Scope.

  6. Click the Authorize button. A Zoho sign-in window opens. Sign in as the Zoho user whose Bigin data Nexla should access, review the requested permissions, and click Accept. The window closes and returns you to the overlay.

    Nexla asks Zoho for offline access and for the consent screen on every authorization, so Zoho issues a refresh token. Nexla renews expired access tokens with the refresh token, so you do not need to re-authorize under normal use.

  7. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Nexla tests the credential by reading the signed-in user's profile from Bigin. The credential can only read or change what the authorizing Zoho user can access in Bigin.

Use as a data source​

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Zoho Bigin connector tile, then select the credential that will be used to connect to the Zoho Bigin instance, and click Next; or, create a new Zoho Bigin credential for use in this flow.

Endpoint templates​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Zoho Bigin endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

Bigin identifies modules by API name, which can differ from the label in the app: companies are Accounts and pipeline records (deals) are Pipelines. Use List Modules to see every module's API name, and List Fields to see a module's field API names.

A module with no records returns no data. If a test shows no sample records, check that the module, record, or Team Pipeline actually has data in Bigin.

List Contacts

This endpoint template lists contacts: name, title, email, mobile, company, owner, email opt-out, and tags. Results are fetched in pages of 200 records, following Bigin's page token, so large modules are read in full.

  • The Fields setting lists the field API names to return, comma-separated (Bigin requires it, maximum 50). The default is Last_Name,First_Name,Title,Email,Mobile,Account_Name,Owner,Email_Opt_Out,Tag,Description,Created_Time,Modified_Time; edit it to change columns. Use the List Fields template to find field API names.
  • Vendor reference: Bigin API: Get records.

List Companies

This endpoint template lists companies (the Accounts module): name, phone, website, owner, and tags. Results are fetched in pages of 200 records, following Bigin's page token, so large modules are read in full.

  • The Fields setting lists the field API names to return, comma-separated (Bigin requires it, maximum 50). The default is Account_Name,Phone,Website,Owner,Tag,Description,Created_Time,Modified_Time; edit it to change columns. Use the List Fields template to find field API names.
  • Vendor reference: Bigin API: Get records.

List Pipeline Records

This endpoint template lists pipeline records (deals) across all Team Pipelines: deal name, company, contact, pipeline, sub-pipeline, stage, amount, and closing date. Results are fetched in pages of 200 records, following Bigin's page token, so large modules are read in full.

  • The Fields setting lists the field API names to return, comma-separated (Bigin requires it, maximum 50). The default is Deal_Name,Account_Name,Contact_Name,Pipeline,Sub_Pipeline,Stage,Amount,Closing_Date,Owner,Tag,Created_Time,Modified_Time; edit it to change columns. Use the List Fields template to find field API names.
  • Vendor reference: Bigin API: Get records.

List Team Pipeline Records

This endpoint template lists the pipeline records (deals) of one Team Pipeline, with stage, sub-pipeline, amount, and closing date. Results are fetched in pages of 200 records.

  • Enter the Team Pipeline ID. Run the List Layouts (Team Pipelines) template with module Pipelines; each layout's id is a Team Pipeline ID.
  • The Fields setting lists the field API names to return, comma-separated (Bigin requires it, maximum 50). The default is Deal_Name,Account_Name,Contact_Name,Pipeline,Sub_Pipeline,Stage,Amount,Closing_Date,Owner,Tag,Created_Time,Modified_Time; edit it to change columns. Use the List Fields template to find field API names.
  • Vendor reference: Bigin API: Get team pipeline records.

List Contact's Team Pipeline Records

This endpoint template lists the records of one Team Pipeline that are associated with one contact.

  • Enter the Contact ID. Use the List Contacts template to find it.
  • Enter the Team Pipeline ID. Run the List Layouts (Team Pipelines) template with module Pipelines; each layout's id is a Team Pipeline ID.
  • The Fields setting lists the field API names to return, comma-separated; the default covers deal name, company, contact, pipeline, sub-pipeline, stage, amount, closing date, owner, tags, and timestamps.
  • Vendor reference: Bigin API: Get team pipeline records related to contact.

List Tasks

This endpoint template lists tasks: subject, due date, status, priority, related record, owner, and reminder. Results are fetched in pages of 200 records, following Bigin's page token, so large modules are read in full.

  • The Fields setting lists the field API names to return, comma-separated (Bigin requires it, maximum 50). The default is Subject,Due_Date,Status,Priority,Related_To,Owner,Remind_At,Description,Tag,Created_Time,Modified_Time; edit it to change columns. Use the List Fields template to find field API names.
  • Vendor reference: Bigin API: Get records.

List Events

This endpoint template lists events: title, start and end time, all-day flag, venue, related record, and participants. Results are fetched in pages of 200 records, following Bigin's page token, so large modules are read in full.

  • The Fields setting lists the field API names to return, comma-separated (Bigin requires it, maximum 50). The default is Event_Title,Start_DateTime,End_DateTime,All_day,Venue,Related_To,Participants,Owner,Description,Tag,Created_Time,Modified_Time; edit it to change columns. Use the List Fields template to find field API names.
  • Vendor reference: Bigin API: Get records.

List Calls

This endpoint template lists calls: subject, call type, start time, duration, related record, and contact. Results are fetched in pages of 200 records, following Bigin's page token, so large modules are read in full.

  • The Fields setting lists the field API names to return, comma-separated (Bigin requires it, maximum 50). The default is Subject,Call_Type,Call_Start_Time,Call_Duration,Related_To,Contact_Name,Owner,Call_Agenda,Description,Dialled_Number,Tag,Created_Time,Modified_Time; edit it to change columns. Use the List Fields template to find field API names.
  • Vendor reference: Bigin API: Get records.

List Products

This endpoint template lists products: name, code, unit price, category, and active flag. Results are fetched in pages of 200 records, following Bigin's page token, so large modules are read in full.

  • The Fields setting lists the field API names to return, comma-separated (Bigin requires it, maximum 50). The default is Product_Name,Product_Code,Unit_Price,Product_Category,Product_Active,Owner,Description,Tag,Created_Time,Modified_Time; edit it to change columns. Use the List Fields template to find field API names.
  • Vendor reference: Bigin API: Get records.

Get Record

This endpoint template retrieves one record from any module, with all of its fields.

  • Select the Module API name (default Contacts). Companies use Accounts and pipeline records (deals) use Pipelines.
  • Enter the Record ID (the record's id, from the module's list template).
  • Vendor reference: Bigin API: Get records.

List Related Records

This endpoint template lists one record's related list, for example a contact's deals or a deal's products. Results are fetched in pages of 200 records.

  • Select the Module API name (default Contacts). Companies use Accounts and pipeline records (deals) use Pipelines.
  • Enter the Record ID (the record's id, from the module's list template).
  • Enter the Related List API name (default Deals), for example Deals, Products, or Contacts2. Use the List Related Lists Metadata template to find it.
  • Set Fields to field API names of the related module (default Deal_Name,Sub_Pipeline,Stage,Pipeline).
  • Vendor reference: Bigin API: Get related records.

List Deleted Records

This endpoint template lists a module's deleted records, with each record's ID, display name, deletion type, and who deleted it and when. Bigin keeps records in the recycle bin for 60 days and lists permanently deleted records for 120 days. Results are fetched in pages of 200 records.

  • Select the Module API name (default Contacts). Companies use Accounts and pipeline records (deals) use Pipelines.
  • Select the Deleted Type: all (default), recycle, or permanent.
  • Vendor reference: Bigin API: Get deleted records.

List Notes

This endpoint template lists notes across all records, with each note's title, content, and parent record. Bigin allows this for admin users only. Results are fetched in pages of 200 records.

  • The Fields setting lists the field API names to return, comma-separated (Bigin requires it, maximum 50). The default is Note_Title,Note_Content,Parent_Id; edit it to change columns. Use the List Fields template to find field API names.
  • Vendor reference: Bigin API: Get notes.

List Record Notes

This endpoint template lists the notes attached to one record. Results are fetched in pages of 200 records.

  • Select the Module API name (default Contacts). Companies use Accounts and pipeline records (deals) use Pipelines.
  • Enter the Record ID (the record's id, from the module's list template).
  • The Fields setting lists the field API names to return, comma-separated (Bigin requires it, maximum 50). The default is Note_Title,Note_Content,Parent_Id; edit it to change columns. Use the List Fields template to find field API names.
  • Vendor reference: Bigin API: Get notes.

List Record Attachments

This endpoint template lists the files attached to one record, with file name, file ID, and size. It does not download the files. Results are fetched in pages of 200 records.

  • Select the Module API name (default Pipelines). Companies use Accounts and pipeline records (deals) use Pipelines.
  • Enter the Record ID (the record's id, from the module's list template).
  • The Fields setting lists the field API names to return, comma-separated (Bigin requires it, maximum 50). The default is File_Name,$file_id,Size,Parent_Id; edit it to change columns. Use the List Fields template to find field API names.
  • Vendor reference: Bigin API: Get attachments.

List Tags

This endpoint template lists the tags defined for one module, with each tag's ID, name, color, and who created and last modified it.

  • Select the Module API name (default Contacts). Companies use Accounts and pipeline records (deals) use Pipelines.
  • Vendor reference: Bigin API: Get tag list.

Get Tag Record Count

This endpoint template counts the records in a module that carry one tag.

  • Select the Module API name (default Contacts). Companies use Accounts and pipeline records (deals) use Pipelines.
  • Enter the Tag ID. Use the List Tags template to find it.
  • Vendor reference: Bigin API: Get record count specific tag.

List Modules

This endpoint template lists the organization's modules, with each module's API name, plural and singular labels, visibility, and API support. Use the API name wherever a template asks for a module.

Get Module Metadata

This endpoint template retrieves one module's metadata: labels, API support, fields, and related list settings.

  • Select the Module API name (default Contacts). Companies use Accounts and pipeline records (deals) use Pipelines.
  • Vendor reference: Bigin API: Module meta.

List Fields

This endpoint template lists a module's fields, with each field's API name, label, data type, length, picklist values, and whether it is mandatory. Use the API names in Fields settings and in destination records.

  • Select the Module API name (default Contacts). Companies use Accounts and pipeline records (deals) use Pipelines.
  • Vendor reference: Bigin API: Field meta.

List Layouts (Team Pipelines)

This endpoint template lists a module's layouts and sections. For the Pipelines module, each layout is a Team Pipeline: its id is the Team Pipeline ID, and it includes the pipeline's sub-pipelines and stages.

  • Select the Module API name (default Pipelines). Companies use Accounts and pipeline records (deals) use Pipelines.
  • Vendor reference: Bigin API: Layouts meta data.

List Related Lists Metadata

This endpoint template lists a module's related lists, with each list's API name, label, and related module. Use the API name with List Related Records.

  • Select the Module API name (default Contacts). Companies use Accounts and pipeline records (deals) use Pipelines.
  • Vendor reference: Bigin API: Related list meta.

List Custom Views

This endpoint template lists a module's custom views, with each view's ID, name, access type, and default and system-view flags.

  • Select the Module API name (default Contacts). Companies use Accounts and pipeline records (deals) use Pipelines.
  • Vendor reference: Bigin API: Custom view meta.

Get Custom View

This endpoint template retrieves one custom view's definition: criteria, fields, sort order, and sharing.

  • Select the Module API name (default Contacts). Companies use Accounts and pipeline records (deals) use Pipelines.
  • Enter the Custom View ID. Use the List Custom Views template to find it.
  • Vendor reference: Bigin API: Custom view meta.

List Users

This endpoint template lists the organization's users, with name, email, role, profile, and status. Results are fetched in pages of 200 records.

  • Select the User Type to return: AllUsers (default), ActiveUsers, DeactiveUsers, ConfirmedUsers, NotConfirmedUsers, DeletedUsers, ActiveConfirmedUsers, AdminUsers, ActiveConfirmedAdmins, or CurrentUser.
  • Vendor reference: Bigin API: Get users.

Get User

This endpoint template retrieves one user's details: name, email, role, profile, status, time zone, and locale.

Get Organization

This endpoint template retrieves the Bigin organization's details: company name, ID, country, time zone, currency, license, and data center.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration​

Zoho Bigin data sources can also be manually configured to ingest data from any valid Bigin API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers. Bigin endpoint URLs take the form https://www.zohoapis.com/bigin/v2/... (with your data center's domain); see the Bigin API documentation for the available endpoints.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Zoho Bigin data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination​

Click the + icon on the Nexset that will be sent to the Zoho Bigin destination, and select the Send to Destination option from the menu. Select the Zoho Bigin connector from the list of available destination connectors, then select the credential that will be used to connect to the Zoho Bigin organization, and click Next; or, create a new Zoho Bigin credential for use in this flow.

Endpoint templates​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Zoho Bigin endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

Each record in the Nexset is sent as the JSON body of one request, one record at a time, so each record must already have the shape Bigin expects. Create, update, and upsert templates take records of the form {"data": [{...}, {...}]}, with up to 100 Bigin records in the data array and field API names as keys. Module, record ID, and other settings on a template are fixed on the destination and apply to every record it sends.

Bigin runs the module's workflow rules on records created or updated through the API. To skip them, include "trigger": [] in the record, for example {"data": [{"Last_Name": "Smith"}], "trigger": []}.

Create Contact

This endpoint template creates contact records. Each Nexset record is one request of up to 100 contact records.

  • Each record has the form {"data": [{...}]}. Required fields: Last_Name. Use the List Fields source template to find field API names.
  • Workflow rules on the module run unless the record includes "trigger": [].
  • Vendor reference: Bigin API: Insert records.

Update Contact

This endpoint template updates existing contact records. Each Nexset record is one request of up to 100 contact records.

  • Each record has the form {"data": [{"id": "<record id>", ...}]}, with each entry's id and only the fields to change; omitted fields are left unchanged.
  • Workflow rules on the module run unless the record includes "trigger": [].
  • Vendor reference: Bigin API: Update records.

Create Company

This endpoint template creates company records. Each Nexset record is one request of up to 100 company records.

  • Each record has the form {"data": [{...}]}. Required fields: Account_Name. Use the List Fields source template to find field API names.
  • Workflow rules on the module run unless the record includes "trigger": [].
  • Vendor reference: Bigin API: Insert records.

Update Company

This endpoint template updates existing company records. Each Nexset record is one request of up to 100 company records.

  • Each record has the form {"data": [{"id": "<record id>", ...}]}, with each entry's id and only the fields to change; omitted fields are left unchanged.
  • Workflow rules on the module run unless the record includes "trigger": [].
  • Vendor reference: Bigin API: Update records.

Create Pipeline Record

This endpoint template creates pipeline (deal) records. Each Nexset record is one request of up to 100 pipeline (deal) records.

  • Each record has the form {"data": [{...}]}. Required fields: Deal_Name, Sub_Pipeline, and Stage. Use the List Fields source template to find field API names.
  • Workflow rules on the module run unless the record includes "trigger": [].
  • Vendor reference: Bigin API: Insert records.

Update Pipeline Record

This endpoint template updates existing pipeline (deal) records. Each Nexset record is one request of up to 100 pipeline (deal) records.

  • Each record has the form {"data": [{"id": "<record id>", ...}]}, with each entry's id and only the fields to change; omitted fields are left unchanged.
  • Workflow rules on the module run unless the record includes "trigger": [].
  • Vendor reference: Bigin API: Update records.

Create Task

This endpoint template creates task records. Each Nexset record is one request of up to 100 task records.

  • Each record has the form {"data": [{...}]}. Required fields: Subject. Use the List Fields source template to find field API names.
  • Workflow rules on the module run unless the record includes "trigger": [].
  • Vendor reference: Bigin API: Insert records.

Update Task

This endpoint template updates existing task records. Each Nexset record is one request of up to 100 task records.

  • Each record has the form {"data": [{"id": "<record id>", ...}]}, with each entry's id and only the fields to change; omitted fields are left unchanged.
  • Workflow rules on the module run unless the record includes "trigger": [].
  • Vendor reference: Bigin API: Update records.

Create Event

This endpoint template creates event records. Each Nexset record is one request of up to 100 event records.

  • Each record has the form {"data": [{...}]}. Required fields: Event_Title, Start_DateTime, and End_DateTime. Use the List Fields source template to find field API names.
  • Workflow rules on the module run unless the record includes "trigger": [].
  • Vendor reference: Bigin API: Insert records.

Update Event

This endpoint template updates existing event records. Each Nexset record is one request of up to 100 event records.

  • Each record has the form {"data": [{"id": "<record id>", ...}]}, with each entry's id and only the fields to change; omitted fields are left unchanged.
  • Workflow rules on the module run unless the record includes "trigger": [].
  • Vendor reference: Bigin API: Update records.

Create Call

This endpoint template creates call records. Each Nexset record is one request of up to 100 call records.

  • Each record has the form {"data": [{...}]}. Required fields: Call_Type, Call_Duration, and Call_Start_Time. Use the List Fields source template to find field API names.
  • Workflow rules on the module run unless the record includes "trigger": [].
  • Vendor reference: Bigin API: Insert records.

Update Call

This endpoint template updates existing call records. Each Nexset record is one request of up to 100 call records.

  • Each record has the form {"data": [{"id": "<record id>", ...}]}, with each entry's id and only the fields to change; omitted fields are left unchanged.
  • Workflow rules on the module run unless the record includes "trigger": [].
  • Vendor reference: Bigin API: Update records.

Create Product

This endpoint template creates product records. Each Nexset record is one request of up to 100 product records.

  • Each record has the form {"data": [{...}]}. Required fields: Product_Name. Use the List Fields source template to find field API names.
  • Workflow rules on the module run unless the record includes "trigger": [].
  • Vendor reference: Bigin API: Insert records.

Update Product

This endpoint template updates existing product records. Each Nexset record is one request of up to 100 product records.

  • Each record has the form {"data": [{"id": "<record id>", ...}]}, with each entry's id and only the fields to change; omitted fields are left unchanged.
  • Workflow rules on the module run unless the record includes "trigger": [].
  • Vendor reference: Bigin API: Update records.

Upsert Records

This endpoint template inserts records, or updates them when they match an existing record on unique fields. Each Nexset record is one request of up to 100 records.

  • Select the Module API name (default Contacts). Companies use Accounts and pipeline records (deals) use Pipelines.
  • Each record has the form {"data": [{...}], "duplicate_check_fields": ["Email"]}; duplicate_check_fields names the fields used to find an existing record.
  • Workflow rules on the module run unless the record includes "trigger": [].
  • Vendor reference: Bigin API: Upsert records.

Delete Records

This endpoint template deletes records from a module.

  • Select the Module API name (default Contacts). Companies use Accounts and pipeline records (deals) use Pipelines.
  • Enter the Record IDs to delete, comma-separated (maximum 100). These settings are fixed on the destination and apply to every record it sends.
  • Side effect: the records are deleted and move to the recycle bin, where Bigin keeps them for 60 days.
  • Vendor reference: Bigin API: Delete records.

Update Related Records

This endpoint template links records to one record's related list, for example products to a deal.

  • Select the Module API name (default Contacts). Companies use Accounts and pipeline records (deals) use Pipelines.
  • Enter the Record ID (the record's id, from the module's list template).
  • Enter the Related List API name (default Deals). Use the List Related Lists Metadata source template to find it.
  • Each record has the form {"data": [{"id": "<related record id>", ...}]}, with up to 100 entries.
  • Vendor reference: Bigin API: Update related records.

Delink Related Records

This endpoint template removes the link between one record and records in its related list. The records themselves are kept.

  • Select the Module API name (default Contacts). Companies use Accounts and pipeline records (deals) use Pipelines.
  • Enter the Record ID (the record's id, from the module's list template).
  • Enter the Related List API name (default Deals).
  • Enter the Related Record IDs to delink, comma-separated (maximum 100). These settings are fixed on the destination and apply to every record it sends.
  • Side effect: the links are removed.
  • Vendor reference: Bigin API: Delink.

Create Note

This endpoint template adds notes to records.

  • Each record has the form {"data": [{"Note_Title": "...", "Note_Content": "...", "Parent_Id": "<record id>", "se_module": "Contacts"}]}, where se_module is the parent record's module.
  • Vendor reference: Bigin API: Create notes.

Update Note

This endpoint template updates one note on a record.

  • Select the Module API name (default Contacts). Companies use Accounts and pipeline records (deals) use Pipelines.
  • Enter the Record ID (the record's id, from the module's list template).
  • Enter the Note ID. Use the List Record Notes or List Notes source template to find it.
  • Each record has the form {"data": [{"Note_Title": "...", "Note_Content": "..."}]}.
  • Vendor reference: Bigin API: Update notes.

Delete Notes

This endpoint template deletes notes.

  • Enter the Note IDs, comma-separated. These settings are fixed on the destination and apply to every record it sends.
  • Side effect: the notes are permanently deleted.
  • Vendor reference: Bigin API: Delete notes.

Delete Attachment

This endpoint template deletes one file attached to a record.

  • Select the Module API name (default Pipelines). Companies use Accounts and pipeline records (deals) use Pipelines.
  • Enter the Record ID (the record's id, from the module's list template).
  • Enter the Attachment ID. Use the List Record Attachments source template to find it.
  • Side effect: the attachment is permanently deleted.
  • Vendor reference: Bigin API: Delete attachments.

Delete Record Photo

This endpoint template deletes a record's profile photo.

  • Select the Module API name (default Contacts). Companies use Accounts and pipeline records (deals) use Pipelines.
  • Enter the Record ID (the record's id, from the module's list template).
  • Side effect: the photo is permanently deleted.
  • Vendor reference: Bigin API: Delete image.

Create Tags

This endpoint template creates tags in a module.

  • Select the Module API name (default Contacts). Companies use Accounts and pipeline records (deals) use Pipelines.
  • Each record has the form {"tags": [{"name": "Important"}]}.
  • Vendor reference: Bigin API: Create tags.

Update Tags

This endpoint template renames tags in a module.

  • Select the Module API name (default Contacts). Companies use Accounts and pipeline records (deals) use Pipelines.
  • Each record has the form {"tags": [{"id": "<tag id>", "name": "<new name>"}]}. Use the List Tags source template to find tag IDs.
  • Vendor reference: Bigin API: Update tags.

Delete Tag

This endpoint template deletes a tag.

  • Enter the Tag ID. Use the List Tags source template to find it.
  • Side effect: the tag is permanently deleted and removed from every record.
  • Vendor reference: Bigin API: Delete tags.

Add Tags to Records

This endpoint template adds tags to records.

  • Select the Module API name (default Contacts). Companies use Accounts and pipeline records (deals) use Pipelines.
  • Set Overwrite Tags to true to replace the records' existing tags, or leave it at false (default) to add to them.
  • Each record has the form {"tags": [{"name": "Hot"}], "ids": ["<record id>"]}.
  • Vendor reference: Bigin API: Add tags records.

Remove Tags from Records

This endpoint template removes named tags from records.

  • Select the Module API name (default Contacts). Companies use Accounts and pipeline records (deals) use Pipelines.
  • Enter the Record IDs, comma-separated (maximum 100), and the Tag Names, comma-separated, with spaces URL-encoded as %20. These settings are fixed on the destination and apply to every record it sends.
  • Vendor reference: Bigin API: Remove tags.

Manual configuration​

Zoho Bigin destinations can also be manually configured to send data to any valid Bigin API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

Save & activate​

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Zoho Bigin endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Zoho Bigin endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.