Zoho CRM is a cloud-based customer relationship management platform that integrates sales, marketing, and customer support activities to streamline business processes and enhance team.

Categories: CRM

Type: zohoCrm/v1

Connections

Version: 1

OAuth2 Authorization Code

Properties

Name	Label	Type	Required
region	Region	STRING Options zoho.eu, zoho.com, zoho.com.au, zoho.jp, zoho.in, zohocloud.ca	true
clientId	Client Id	STRING	true
clientSecret	Client Secret	STRING	true

Connection Setup

Create OAuth 2.0 Application

Creation of OAuth 2.0 application is documented here.

Login to your account at https://www.zoho.com/crm/.
In Bytechef, choose your region based on Zoho CRM domain you are using.

Actions

Add User

Name: addUser

Add user to your organization.

Properties

Name	Label	Type	Description	Required
first_name	First Name	STRING	First name of the user.	true
last_name	Last Name	STRING	Last name of the user.	false
email	Email	STRING	User's email. An invitation will be sent to this email address.	true
role	Role ID	STRING	ID of the role you want to assign the user with.	true
profile	Profile ID	STRING	ID of the profile you want to assign the user with.	true

Example JSON Structure

{
  "label" : "Add User",
  "name" : "addUser",
  "parameters" : {
    "first_name" : "",
    "last_name" : "",
    "email" : "",
    "role" : "",
    "profile" : ""
  },
  "type" : "zohoCrm/v1/addUser"
}

Properties

Name	Type	Description
users	ARRAY Items [{STRING(code), {STRING(id)}(details), STRING(message), STRING(status)}]

Output Example

{
  "users" : [ {
    "code" : "",
    "details" : {
      "id" : ""
    },
    "message" : "",
    "status" : ""
  } ]
}

Get Organization

Name: getOrganization

Gets information about the current organization.

Example JSON Structure

{
  "label" : "Get Organization",
  "name" : "getOrganization",
  "type" : "zohoCrm/v1/getOrganization"
}

Properties

Name	Type	Description
org	ARRAY Items [{STRING(country), STRING(city), STRING(street), STRING(zip), STRING(photo_id), STRING(description), STRING(alias), STRING(created_time), STRING(type), STRING(currency), STRING(id), STRING(phone), STRING(company_name), STRING(primary_email), STRING(website)}]

Output Example

{
  "org" : [ {
    "country" : "",
    "city" : "",
    "street" : "",
    "zip" : "",
    "photo_id" : "",
    "description" : "",
    "alias" : "",
    "created_time" : "",
    "type" : "",
    "currency" : "",
    "id" : "",
    "phone" : "",
    "company_name" : "",
    "primary_email" : "",
    "website" : ""
  } ]
}

List Users

Name: listUsers

Lists users found in Zoho account.

Properties

Name	Label	Type	Description	Required
type	Type	STRING Options AllUsers, ActiveUsers, DeactiveUsers, ConfirmedUsers, NotConfirmedUsers, DeletedUsers, ActiveConfirmedUsers, AdminUsers, ActiveConfirmedAdmins, CurrentUser	What type of user to return in list.	true

Example JSON Structure

{
  "label" : "List Users",
  "name" : "listUsers",
  "parameters" : {
    "type" : ""
  },
  "type" : "zohoCrm/v1/listUsers"
}

Properties

Name	Type	Description
users	ARRAY Items [{STRING(country), STRING(language), STRING(id), {STRING(name), STRING(id)}(profile), {STRING(name), STRING(id)}(created_by), STRING(full_name), STRING(status), {STRING(name), STRING(id)}(role), STRING(first_name), STRING(email)}]

Output Example

{
  "users" : [ {
    "country" : "",
    "language" : "",
    "id" : "",
    "profile" : {
      "name" : "",
      "id" : ""
    },
    "created_by" : {
      "name" : "",
      "id" : ""
    },
    "full_name" : "",
    "status" : "",
    "role" : {
      "name" : "",
      "id" : ""
    },
    "first_name" : "",
    "email" : ""
  } ]
}

What to do if your action is not listed here?

If this component doesn't have the action you need, you can use Custom Action to create your own. Custom Actions empower you to define HTTP requests tailored to your specific requirements, allowing for greater flexibility in integrating with external services or APIs.

To create a Custom Action, simply specify the desired HTTP method, path, and any necessary parameters. This way, you can extend the functionality of your component beyond the predefined actions, ensuring that you can meet all your integration needs effectively.

Additional Instructions

How to find the Role ID

Method 1: Via API

Use the GET /settings/roles endpoint to retrieve a list of all roles and their IDs.

The Role ID can also be found in the output of the following actions:

List Users

How to find the Profile ID

Method 1: Via API

Use the GET /settings/profiles endpoint to retrieve a list of all profiles and their IDs.

The Profile ID can also be found in the output of the following actions:

List Users

Zoho CRM

Connections

OAuth2 Authorization Code

Properties

Connection Setup

Create OAuth 2.0 Application

Actions

Add User

Properties

Example JSON Structure

Output

Properties

Output Example

Find Role ID

Find Profile ID

Get Organization

Example JSON Structure

Output

Properties

Output Example

List Users

Properties

Example JSON Structure

Output

Properties

Output Example

What to do if your action is not listed here?

Additional Instructions

How to find the Role ID

How to find the Profile ID

On this page