Zoho CRM Actions API
The Actions API from Zoho CRM — 36 operation(s) for actions.
Zoho CRM Actions API is one of 36 APIs that Zoho CRM publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include Actions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and an API reference.
This API exposes 48 operations across 36 paths, and defines 130 schemas. It is described by OpenAPI 3.2.0, at version 1.0.
Requests are made against 3 base URLs: https://www.zohoapis.com/crm/{version}, https://zohoapis.{dc}/crm/{version}, https://www.zohoapis.{dc}/crm/{version}.
48 operations
36 paths
130 schemas
2 DELETE9 GET1 PATCH34 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Zoho CRM Actions API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (iam-oauth2-schema) using the authorizationCode flow, exposing 3 scopes.
iam-oauth2-schema— Zoho CRM OAuth2 Authentication.
Paths & Operations 48
Across 36 paths, the API surfaces 48 operations — 2 DELETE, 9 GET, 1 PATCH, 34 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
Actions 48
POST
/{module}/{recordId}/actions/associate_email
Associate Email
POST
/{module}/actions/unenrol_from_cadences
Unenroll records from cadences
POST
/{module}/actions/enrol_in_cadences
Enroll records into cadences
POST
/{module}/{record}/actions/change_owner
Change owner for a single record
POST
/{module}/actions/change_owner
Change owner for multiple records
GET
/{moduleApiName}/actions/fetch_full_data
Fetch full data for multiple records
GET
/{moduleApiName}/{id}/actions/fetch_full_data
Fetch full data for a single record
GET
/{module}/{masterRecordId}/actions/merge
Get Merge Job Status
POST
/{module}/{masterRecordId}/actions/merge
Merge Records
POST
/{moduleApiName}/{recordId}/actions/get_related_records_count
Get Related Records Count
POST
/{moduleApiName}/{id}/actions/convert
Convert an inventory record
POST
/{moduleApiName}/{recordId}/actions/send_mail_merge
POST /{moduleAPIname}/{recordId}/actions/sendmailmerge
POST
/{moduleApiName}/{recordId}/actions/sign_mail_merge
POST /{moduleAPIname}/{recordId}/actions/signmailmerge
POST
/{moduleApiName}/{recordId}/actions/download_mail_merge
POST /{moduleAPIname}/{recordId}/actions/downloadmailmerge
POST
/{module}/actions/mass_change_owner
Mass change owner of records
GET
/{module}/actions/mass_change_owner
Check mass change owner job status
POST
/{module}/actions/mass_delete
Mass delete with record ids and custom view id
GET
/{module}/actions/mass_delete
Retrieve mass delete job status
POST
/{module}/actions/mass_update
Mass Update API
GET
/{module}/actions/mass_update
Retrieve the status of a mass update job
GET
/actions/watch
List active notification channels
POST
/actions/watch
Create notification channels
PUT
/actions/watch
Update full notification details
PATCH
/actions/watch
Update specific notification information
DELETE
/actions/watch
Disable notification channels
POST
/{module}/actions/portal_invite
Invite portal users
GET
/{module}/actions/portal_invite
Invite portal users
POST
/{module}/{recordId}/actions/portal_invite
Invite portal users
POST
/{module}/{recordID}/actions/clone
To clone a record in a module
POST
/{moduleApiName}/{id}/actions/share_emails
Share Emails of a record
POST
/{moduleApiName}/{id}/actions/unshare_emails
Unshare Emails of a record
POST
/{moduleApiName}/actions/share_emails
Share Emails in Bulk
POST
/{moduleApiName}/actions/unshare_emails
Unshare Emails in Bulk
POST
/{moduleName}/{id}/actions/send_mail
Send an email to a record
GET
/{moduleApiName}/{recordId}/actions/share
Get Share Records
POST
/{moduleApiName}/{recordId}/actions/share
Create Share Records
PUT
/{moduleApiName}/{recordId}/actions/share
Update Share Records
DELETE
/{moduleApiName}/{recordId}/actions/share
Delete Share Records
POST
/{module}/actions/add_tags
POST /{module}/actions/addtags
POST
/{module}/actions/remove_tags
POST /{module}/actions/removetags
POST
/{module}/{id}/actions/add_tags
POST /{module}/{id}/actions/addtags
POST
/{module}/{id}/actions/remove_tags
POST /{module}/{id}/actions/removetags
POST
/{module}/{record}/actions/assign_territories
Asssign Territories To Record
POST
/{module}/actions/assign_territories
Asssign Territories To Records
POST
/{module}/{record}/actions/remove_territories
Remove Territories To Record
POST
/{module}/actions/remove_territories
Remove Territories To Records
POST
/{module}/actions/unblock_email
Unblock bulk emails in a module
POST
/{module}/{id}/actions/unblock_email
Unblock single email
Schemas 130
The contract defines 130 schemas that model the data the API accepts and returns. The most detailed are EmailObject (11 properties), SendMailMergeNested (9 properties), ErrorDetails_2 (8 properties), PostaddtagsResponse200 (6 properties). Each schema is shown below with its type and property counts.
ErrorResponse
object
Details about a failed API request.
4 properties
AttachmentRef
object
Reference to an email attachment.
1 property
1 required
ActionResponse
object
Generic wrapper for multiple record action responses.
1 property
EmailAddress
object
Object representing an email address and display name.
2 properties
1 required
AssociateEmailRequest
object
Request body for associating an email with a record.
1 property
1 required
EmailObject
object
Detailed email metadata object.
11 properties
7 required
PostcadencesResponse200
object
Successful API operation completed
1 property
PostcadencesResponse207
object
Multi status response for unenrolment
1 property
ErrorDataNested
object
Nested schema for data
4 properties
ErrorResponseCore814179042
object
Invalid data type for field: cadencesids
4 properties
4 required
ErrorResponseCore1137512454
object
Invalid data type for field: cadencesids
4 properties
4 required
ErrorResponseCore260315750
object
API not supported for client portal users
4 properties
4 required
CadencesNested
object
Nested schema for cadences
2 properties
ErrorResponseCore1414382895
object
id given is not manual enrollment cadence
4 properties
4 required
PostCadencesRequest
object
Request body schema
2 properties
2 required
ErrorResponseCore1243473672
object
API not supported for selected domains
4 properties
4 required
DetailsNested
object
Nested schema for details
2 properties
ErrorResponse403
object
No permission to access this resource
4 properties
4 required
ErrorResponseCore1362235056
object
Invalid data type for field: ids
4 properties
4 required
SuccessDataNested
object
Nested schema for data
4 properties
CountParameters
object
Optional filtering and selection parameters to apply before counting records.
5 properties
1 required
FilterField
object
Specifies the field to filter on when counting related records.
1 property
1 required
RelatedListReference
object
Identifies a specific related list by its API name and unique identifier.
2 properties
2 required
ErrorResponse_2
object
Error response structure
4 properties
4 required
RelatedRecordCountResult
object
The count result for a specific related list.
2 properties
2 required
FilterCriteria
object
Field-based filter criteria to apply before counting records.
3 properties
3 required
GetRelatedRecordsCountRequest
object
Request payload containing an array of related list count specifications.
1 property
1 required
ErrorDetails
RelatedRecordCountItem
object
Specifies a related list to count and optional filtering criteria.
2 properties
1 required
GetRelatedRecordsCountResponse
object
Successful response containing count results for the requested related lists.
1 property
1 required
CcEmailNested
object
The details of the email or the mail merge field you want to include in the email's cc. The keys are same as the ones in the "fromaddress" JSON object.
2 properties
2 required
MandatoryFieldNotFoundError
object
Error when a required field is missing
4 properties
4 required
ExpectedFieldMissingError
object
Error when at least one expected field is missing
4 properties
4 required
InvalidDataParamError
object
Error when invalid data is sent in a parameter
4 properties
4 required
ExpectedParamMissingError
object
Error when one of the expected parameters is missing to process the request
4 properties
4 required
BccEmailNested
object
The details of the email or the mail merge field you want to include in the email's bcc. The keys are same as the ones in the "fromaddress" JSON object.
2 properties
2 required
SendMailMergeNested1
object
Response payload for send mail merge operation.
4 properties
DownloadMailMergeNested
object
Request payload for downloading mail merge documents.
3 properties
1 required
PostsignmailmergeRequest
object
Request body schema for sign mail merge operation.
1 property
1 required
MailMergeTemplateNested
object
Mailmerge Object to pass Template details
1 property
1 required
MandatoryFieldNotFoundBodyError
object
Error when a required field is not found in the request body
4 properties
4 required
PostsendmailmergeResponse200
object
Upon successful initiation of send mail merge the response as follows.
1 property
ToAddressNested
object
The email ID you want to use to send emails to.
2 properties
2 required
InvalidDataMaxLengthError
object
Error when data exceeds maximum allowed length
4 properties
4 required
InvalidDataTypeError
object
Error when the data type provided is invalid
4 properties
4 required
InvalidModuleParamError
object
Error when the module given in the parameter is invalid
4 properties
4 required
DetailsNested1
object
Response details for sign mail merge operation.
2 properties
RequiredParamMissingError
object
Error when a mandatory parameter is not given
4 properties
4 required
FromAddressNested
object
The email ID you want to use to send emails from. This email address must be the one of the org-verified email addresses or the current user's email ID.
2 properties
2 required
PostsendmailmergeRequest
object
Request body schema for send mail merge operation.
1 property
1 required
PostdownloadmailmergeRequest
object
Request body schema for download mail merge operation.
1 property
1 required
PostsignmailmergeResponse200
object
Upon successful initiation of sign mail merge the response as follows.
1 property
DetailsNested_2
object
Response details for send mail merge operation.
1 property
RecipientNested
object
Recipient details for signature or approval
2 properties
2 required
SendMailMergeNested
object
Request payload for sending mail merge emails.
9 properties
1 required
SignersNested
object
The details of the users you want to sign the document.
3 properties
3 required
InvalidModulePathError
object
Error when the module given in the URL path is invalid
4 properties
4 required
SignMailMergeNested
object
Request payload for sending documents for signature.
4 properties
2 required
SignMailMergeNested1
object
Response payload for sign mail merge operation.
4 properties
InvalidRequestMethodError
object
Error when the HTTP request method is not supported for the URL
4 properties
4 required
InvalidDataUrlError
object
Error when invalid data is sent in the URL
4 properties
4 required
ErrorResponse_3
object
Standard error response structure containing error code, message, and optional details
4 properties
3 required
ErrorDetails_2
object
Specific details about the error, often including which parameter or value caused the issue.
8 properties
RecordSuccessResponse
object
Standard success response schema for single or bulk record operations.
1 property
1 required
RecordsInputSchema
object
Input schema for create, update, or upsert record requests.
4 properties
1 required
RecordInvalidURLResponse
object
Response schema returned when the requested API endpoint URL pattern is invalid or unsupported.
1 property
RecordsErrorResponse
object
Standard error response schema returned when one or more record operations fail.
1 property
RecordUnathorizedResponse
object
Response schema returned when a request is unauthorized due to OAuth scope mismatches.
1 property
RecordPermissionResponse
object
Response schema returned when a user lacks the necessary permissions to perform a record operation.
1 property
RecordInternalErrorResponse
object
Schema for internal server error responses related to record operations.
1 property
SendMailRequest
object
Root object for the send mail request.
1 property
1 required
ErrorDetail
object
Individual error item.
4 properties
FlatErrorResponse
object
Flat error object.
4 properties
2 required
SuccessResponse
object
Successful operation response.
1 property
StandardErrorResponse
object
Error data wrapper.
1 property
1 required
EmailUser
object
User email and name details.
2 properties
1 required
NoSharingAvailableToRevokeErrorResponse
object
No Sharing Available To Revoke Error Response - DELETE API
4 properties
4 required
MaximumLengthErrorResponse
object
Maximum Length Error Response - POST and PUT API
4 properties
4 required
InvalidShareWithValueErrorResponse
object
Invalid Share With Value Error Response - POST and PUT API
1 property
1 required
ShareLimitExceedErrorResponse
object
Share Limit Exceed Error Response - POST and PUT API
1 property
1 required
InvalidRecordIdErrorResponse
object
Invalid Record Id Error Response - GET, DELETE API
4 properties
4 required
AmbiguousShareErrorResponse
object
Ambiguous Share Error Response - POST and PUT API
4 properties
InvalidShareWithIdErrorResponse
object
Invalid Share With User Id Error Response - POST and PUT API
1 property
1 required
MandatoryNotFound
object
Mandatory Not Found Error Response - POST and PUT API
1 property
InvalidModuleNameErrorResponse
object
Invalid Module Name Error Response - GET, DELETE API
4 properties
4 required
CommonForbiddenErrorResponse
object
Common Forbidden Error Response
4 properties
4 required
ActivityModuleRelatedIssueErrorResponse
object
Activity Module Related Issue Error Response - POST and PUT API
1 property
1 required
NotifyMembersWithoutFeeds
object
Notify Members Without Feeds - POST and PUT API
4 properties
4 required
UnsupportedModule
object
Invalid Module - POST and PUT API
4 properties
4 required
SharingSharedRecordErrorResponse
object
Sharing Shared Record Error Response - POST and PUT API
4 properties
4 required
RecordForbiddenErrorResponse
object
Record Forbidden Error Response
4 properties
4 required
InvalidTypeErrorResponse
object
Invalid Type Error Response - GET API
1 property
1 required
RecordLevelSharingNotSupportedForModuleErrorResponse
object
Record Level Sharing Not Supported For Module Error Response - POST and PUT API
4 properties
4 required
ViewParamWithManageValueErrorResponse
object
View Param With Manage Value Error Response - GET API
4 properties
4 required
SchedularAlreadyRunningErrorResponse
object
Schedular Already Running Error Response - POST and PUT API
4 properties
4 required
ErrorResponseCore1273605641
object
When the module name is valid but that doesn't have tags support
4 properties
4 required
PostaddtagsResponse200
object
success response when tags associated successfully to records
6 properties
ErrorResponseCore1875045219
object
When invalid request method is given
4 properties
4 required
ErrorResponseCore1335454202
object
When the given module name is invalid
4 properties
4 required
ErrorResponseCore2107518198
object
When we try to associate tag for locked record
4 properties
4 required
ErrorResponseCore94581445
object
Missing required parameter: module
4 properties
4 required
ErrorResponseCore356490233
object
Auto-generated from ApiDefinition for INVALIDDATA
4 properties
4 required
ErrorResponseCore1161913208
object
When permission doesn't exists
4 properties
4 required
TagErrorItemResponse
object
Error object for individual tag failures
4 properties
4 required
ErrorResponseCore833637355
object
When tag given in invalid data type
4 properties
4 required
PostaddtagsRequest
object
Request body schema
3 properties
1 required
ErrorResponseCore239878082
object
Auto-generated from ApiDefinition for INVALIDDATA
4 properties
4 required
DetailsNested_3
object
Nested schema for details
4 properties
PostremovetagsResponse200
object
success response when tags removed from records successfully
2 properties
DataNested
object
Nested schema for data
4 properties
TagsNested1
object
Nested schema for tags
3 properties
ErrorResponseCore1799630392
object
Invalid data type for field: tags
4 properties
4 required
TagsNested
object
root key
4 properties
MappingMismatchErrorResponse
object
When tag given in invalid data type
4 properties
4 required
PostremovetagsRequest
object
Request body schema
2 properties
1 required
TerritoryAssignMandatoryNotFound
object
Schema for error responses returned during territory creation or update.
1 property
1 required
NotSupportedForRemoveTerritoryRecord
object
Schema for error responses returned during territory creation or update.
1 property
1 required
TerritoryLimitExceededErrorSchema
object
A object value.
4 properties
4 required
TerritoryAssignNotSupported
object
Schema for error responses returned during territory creation or update.
1 property
1 required
TerritoryInternalServerErrorSchema
object
A object value.
4 properties
4 required
TerritoryErrorPermissionDenied
object
A object value.
4 properties
4 required
TerritoryAssignNoPermission
object
Schema for error responses returned during territory creation or update.
1 property
1 required
TerritorySchedueledSuccessCode
object
A object value.
1 property
1 required
TerritoryAssignInvalidDataOnURL
object
Schema for error responses returned during territory creation or update.
1 property
1 required
TerritoryAssignInvalidDataMaxLen
object
Schema for error responses returned during territory creation or update.
4 properties
4 required
TerritoryAssignRecordLocked
object
Schema for error responses returned during territory creation or update.
1 property
1 required
TerritoryAssignDuplicateData
object
Schema for error responses returned during territory creation or update.
1 property
1 required
TerritoryAssignAlreadyUsed
object
Schema for error responses returned during territory creation or update.
1 property
1 required
InvalidModule
object
A object value.
4 properties
4 required
TerritoryAssignInvalidDataTerritoryId
object
Schema for error responses returned during territory creation or update.
1 property
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Zoho CRM 12
Other APIs Zoho CRM publishes across the network.
Zoho CRM Appointments S API
Zoho CRM Attachments API
Zoho CRM Composite Requests API
Zoho CRM Contact Roles API
Zoho CRM Contacts API
Zoho CRM Coql API
Zoho CRM Deleted API
Zoho CRM Email Drafts API
Zoho CRM Emails API
Zoho CRM Emails Sharing Details API
Zoho CRM Events API
Zoho CRM Features API
#Actions
Where this information came from
This is an independent, third-party profile of Zoho CRM Actions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.