Skip to main content
Zoho Bigin
Previewv0.2.1
75 actions · 21 events · 2 auth methods
CRMIAM

Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See Organizations & Projects.
2

Configure the Connector

Enable the connector and create a Connector Profile in your project. See Setup Connector Profile.

OAuth 2.0 · Connector Profile

Each person connecting signs in to Zoho. One server-based client in the Zoho API Console serves every Bigin organization…

Self Client · Connector Profile

No sign-in when connecting. A Self Client created in the Zoho API Console connects only the Bigin organization it was cr…
Optionally, configure receiving Events for Zoho Bigin into StackOne.

Webhooks setup

3

Link an Account

Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

OAuth 2.0 · Link Account

Self Client · Link Account

4

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

Actions

|
75 actions
Action
Description
Required scopes
Get Attachments
List the files attached to a Bigin record.
Upload Attachment
Attach a file or a link to a Bigin record, such as a contract on a deal or a document on a contact.
Download Attachment
Download a file attached to a Bigin record.
Delete Attachment
Delete a file attached to a Bigin record.
Create Bulk Read Job
Start a background job that exports Bigin records to a CSV file.
Get Bulk Read Job Details
Check the status of a Bigin bulk read job.
Download Bulk Read Result
Download the exported records of a completed Bigin bulk read job.
Upload Bulk Write File
Upload a zipped CSV file to use in a Bigin bulk write job.
Create Bulk Write Job
Start a background job that inserts, updates or upserts Bigin records from an uploaded file.
Get Bulk Write Job Details
Check the status of a Bigin bulk write job.
Download Bulk Write Result
Download the per-row result file of a completed Bigin bulk write job.
Get From Addresses
List the email addresses the connected Bigin user may send email from.
Send Mail
Send an email from Bigin to a contact, company or deal, logged on that record.
Upload Files
Upload a file to Bigin storage to use in a file upload or image field.
Get Files
Download a file stored in Bigin by its encrypted ID.
Get Unified Credentials
Get the identity of the current Zoho Bigin connection.
List Unified Roles
List unified roles and permission profiles in Zoho Bigin.
Get Unified Role
Get a unified Zoho Bigin role or permission profile by id.
List Unified Users
List unified users in Zoho Bigin.
Get Unified User
Get a unified Zoho Bigin user by id.
Upload Profile Photo
Set the profile image of a Bigin contact, company or product.
Download Profile Photo
Download the profile image of a Bigin contact, company or product.
Delete Profile Photo
Remove the profile image of a Bigin contact, company or product.
Get Modules
List the modules of the Bigin organization with their API names.
Get Module
Get the metadata of one Bigin module, such as its labels, permissions and related lists.
Get Fields
List the fields of a Bigin module with their API names, types and picklist values.
Get Layouts
List the layouts of a Bigin module. For Pipelines, each layout is a team pipeline with its sub-pipelines and stages.
Get Related Lists
List the related lists of a Bigin module, such as Contacts or Products on a company.
Get Custom Views
List the custom views (saved filters) of a Bigin module.
Get Custom View
Get one custom view of a Bigin module with its criteria and fields.
Get Notes
List the notes across all records in Bigin.
Get Record Notes
List the notes of one Bigin record.
Add Notes
Add notes to Bigin records, such as a call summary on a contact or deal.
Update Notes
Change the title or text of a note on a Bigin record.
Delete Notes
Delete Bigin notes by ID.
Enable Notifications
Subscribe a URL to create, edit or delete events of Bigin modules.
Get Notification Details
List the Bigin notification channels and their events.
Update Notification Details
Replace the settings of Bigin notification channels.
Update Notification Info
Change some settings of Bigin notification channels and keep the rest.
Disable Notifications
Stop Bigin notification channels.
Get Organization
Get the Zoho Bigin organization this connection is bound to.
Upload Organization Image
Set the logo of the Zoho Bigin organization.
Get Team Pipeline Records
List the deals (pipeline records) of one Bigin team pipeline.
Get Team Pipeline Records Related To Contact
List the deals of one Bigin team pipeline that a contact is part of.
Get Profiles
List the permission profiles of a Zoho Bigin organization.
Get Records
List the records of a Bigin module, such as contacts, companies, products or activities.
Get Record
Get one record of a Bigin module by its ID, with all its fields.
Add Records
Create up to 100 records in a Bigin module, such as contacts, companies, deals, products or activities.
Update Records
Update up to 100 existing records of a Bigin module.
Upsert Records
Insert records, or update them when a matching record already exists in the Bigin module.
Delete Records
Delete up to 100 records of a Bigin module. Deleted records go to the recycle bin.
Search Records
Search the records of a Bigin module by criteria, email, phone or word.
Get Deleted Records
List records deleted from a Bigin module, in the recycle bin or permanently deleted.
Get Records Count
Count the records of a Bigin module.
Get Records (COQL)
Query Bigin records with a SQL-like COQL SELECT statement.
Change Record Owner
Assign up to 500 records of a Bigin module to another user.
Get Related Records
List the records in a related list of a Bigin record, such as the contacts of a company or the products of a deal.
Update Related Records
Link records to a Bigin record through a related list, such as adding products to a deal or contacts to a deal.
Delink Related Records
Unlink records from a Bigin record related list. The records themselves are kept.
Get Roles
List the hierarchy roles of a Zoho Bigin organization.
Get Tag List
List the tags of a Bigin module.
Add Tags
Create tags in a Bigin module.
Update Tags
Rename tags of a Bigin module.
Delete Tags
Delete a tag from Bigin. Records keep their data but lose the tag.
Add Tags To Records
Add tags to records of a Bigin module.
Remove Tags From Records
Remove tags from records of a Bigin module.
Get Record Count For Tag
Count the records of a Bigin module that carry a tag.
Get Users
List the users of a Zoho Bigin organization with their role and profile.
Get User
Get one Zoho Bigin user by id with their role and profile.
Get Current User
Get the Zoho Bigin user this connection signs in as.
Check User Access
Read one user, the organization and the admin list from Zoho Bigin to prove the connection can serve the roster and expa…
Add User
Invite a new user to the Bigin organization.
Update Users
Update details of several Bigin users in one call.
Update Specific User
Update the details of one Bigin user.
Delete User
Delete a user from the Bigin organization.

Events

|
21 events
Event
Description
Tags
Task Created
Fired when a task is created in Bigin.
Activities
Task Updated
Fired when a task is updated in Bigin.
Activities
Task Deleted
Fired when a task is deleted in Bigin.
Activities
Event Created
Fired when an event (meeting) is created in Bigin.
Activities
Event Updated
Fired when an event (meeting) is updated in Bigin.
Activities
Event Deleted
Fired when an event (meeting) is deleted in Bigin.
Activities
Call Created
Fired when a call is created in Bigin.
Activities
Call Updated
Fired when a call is updated in Bigin.
Activities
Call Deleted
Fired when a call is deleted in Bigin.
Activities
Contact Created
Fired when a contact is created in Bigin.
Records
Contact Updated
Fired when a contact is updated in Bigin.
Records
Contact Deleted
Fired when a contact is deleted in Bigin.
Records
Pipeline Created
Fired when a pipeline record (deal) is created in Bigin.
Records
Pipeline Updated
Fired when a pipeline record (deal) is updated in Bigin.
Records
Pipeline Deleted
Fired when a pipeline record (deal) is deleted in Bigin.
Records
Company Created
Fired when a company is created in Bigin.
Records
Company Updated
Fired when a company is updated in Bigin.
Records
Company Deleted
Fired when a company is deleted in Bigin.
Records
Product Created
Fired when a product is created in Bigin.
Records
Product Updated
Fired when a product is updated in Bigin.
Records
Product Deleted
Fired when a product is deleted in Bigin.
Records