Skip to content

Zoho CRM

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

NameLabelTypeDescriptionRequired
regionRegionSTRING
Options zoho.eu, zoho.com, zoho.com.au, zoho.jp, zoho.in, zohocloud.ca
true
clientIdClient IdSTRINGtrue
clientSecretClient SecretSTRINGtrue

Actions

Add User

Name: addUser

Add user to your organization.

Properties

NameLabelTypeDescriptionRequired
first_nameFirst NameSTRINGFirst name of the user.true
last_nameLast NameSTRINGLast name of the user.false
emailEmailSTRINGUser’s email. An invitation will be sent to this email addresstrue
roleRole IDSTRINGID of the role you want to assign the user with.true
profileProfile IDSTRINGID 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"
}

Output

Type: OBJECT

Properties

NameTypeDescription
usersARRAY
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"
}

Output

Type: OBJECT

Properties

NameTypeDescription
orgARRAY
Items [{STRING(type), STRING(id), STRING(phone), STRING(company_name), STRING(primary_email)}]

Output Example

{
"org" : [ {
"type" : "",
"id" : "",
"phone" : "",
"company_name" : "",
"primary_email" : ""
} ]
}

List Users

Name: listUsers

Lists users found in Zoho account.

Properties

NameLabelTypeDescriptionRequired
typeTypeSTRING
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"
}

Output

Type: OBJECT

Properties

NameTypeDescription
usersARRAY
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" : ""
} ]
}