Zoho CRM Actions API

openapi: 3.2.0
info:
  title: Zoho Crm Actions API
  version: '1.0'
  description: 'Operations tagged Actions across 20 of this provider''s published API definitions: zoho-crm-associate-email-openapi.json, zoho-crm-cadences-execution-openapi.json, zoho-crm-change-owner-openapi.json, zoho-crm-fetch-full-data-openapi.json, zoho-crm-find-and-merge-openapi.json, zoho-crm-get-related-records-count-openapi.json, zoho-crm-inventory-convert-openapi.json, zoho-crm-mail-merge-openapi.json, zoho-crm-mass-change-owner-openapi.json, zoho-crm-mass-delete-cvid-openapi.json, zoho-crm-mass-update-openapi.json, zoho-crm-notifications-openapi.json, zoho-crm-portal-users-openapi.json, zoho-crm-record-openapi.json, zoho-crm-record-share-email-openapi.json, zoho-crm-send-mail-openapi.json, zoho-crm-share-records-openapi.json, zoho-crm-tags-actions-openapi.json, zoho-crm-territories-openapi.json, zoho-crm-unblock-email-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://www.zohoapis.com/crm/{version}
  description: Production Server (US)
  variables:
    version:
      default: v8
      description: API version
- url: https://zohoapis.{dc}/crm/{version}
  description: API Server URL
  variables:
    dc:
      description: API Server URL TLD
      default: com
      enum:
      - eu
      - com
      - au
      - in
      - jp
      - cn
      - ca
    version:
      description: API Version
      default: v8
- url: https://www.zohoapis.{dc}/crm/{version}
  description: API Server URL
  variables:
    dc:
      enum:
      - com
      - eu
      - in
      - cn
      - au
      default: com
      description: API Server URL TLD
    version:
      enum:
      - v8
      default: v8
      description: API version
tags:
- name: Actions
paths:
  /{module}/{recordId}/actions/associate_email:
    post:
      summary: Associate Email
      description: Associates emails to a specific record in a module.
      operationId: associateEmail
      security:
      - iam-oauth2-schema:
        - ZohoCRM.modules.emails.CREATE
      parameters:
      - name: module
        in: path
        required: true
        description: The API name of the module (e.g., Leads, Contacts).
        schema:
          type: string
          maxLength: 100
      - name: recordId
        in: path
        required: true
        description: The unique ID of the record to associate the email with.
        schema:
          type: string
          maxLength: 100
      requestBody:
        description: Payload containing the email details to be associated.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssociateEmailRequest'
      responses:
        '200':
          description: Email associated successfully.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ActionResponse'
        '400':
          description: Bad Request.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ErrorResponse'
      tags:
      - Actions
    servers:
    - url: https://www.zohoapis.com/crm/{version}
      description: Production Server (US)
      variables:
        version:
          default: v8
          description: API version
  /{module}/actions/unenrol_from_cadences:
    post:
      summary: Unenroll records from cadences
      description: Un-Enroll records from the cadences
      operationId: postUnenrolFromCadences
      security:
      - iam-oauth2-schema:
        - ZohoCRM.modules.Leads.CREATE
      - iam-oauth2-schema:
        - ZohoCRM.modules.Contacts.CREATE
      - iam-oauth2-schema:
        - ZohoCRM.modules.Accounts.CREATE
      - iam-oauth2-schema:
        - ZohoCRM.modules.Deals.CREATE
      - iam-oauth2-schema:
        - ZohoCRM.modules.Tasks.CREATE
      - iam-oauth2-schema:
        - ZohoCRM.modules.Events.CREATE
      - iam-oauth2-schema:
        - ZohoCRM.modules.Calls.CREATE
      - iam-oauth2-schema:
        - ZohoCRM.modules.Products.CREATE
      - iam-oauth2-schema:
        - ZohoCRM.modules.Vendors.CREATE
      - iam-oauth2-schema:
        - ZohoCRM.modules.Campaigns.CREATE
      - iam-oauth2-schema:
        - ZohoCRM.modules.Cases.CREATE
      - iam-oauth2-schema:
        - ZohoCRM.modules.Solutions.CREATE
      - iam-oauth2-schema:
        - ZohoCRM.modules.Quotes.CREATE
      - iam-oauth2-schema:
        - ZohoCRM.modules.Invoices.CREATE
      - iam-oauth2-schema:
        - ZohoCRM.modules.Forecasts.CREATE
      - iam-oauth2-schema:
        - ZohoCRM.modules.Activities.CREATE
      - iam-oauth2-schema:
        - ZohoCRM.modules.Notes.CREATE
      - iam-oauth2-schema:
        - ZohoCRM.modules.Attachments.CREATE
      - iam-oauth2-schema:
        - ZohoCRM.modules.custom.CREATE
      parameters:
      - $ref: '#/components/parameters/Module'
      requestBody:
        description: Request body
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostCadencesRequest'
      responses:
        '200':
          description: OK - Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostcadencesResponse200'
        '207':
          description: Multi-Status — Response contains mixed status results
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostcadencesResponse207'
        '400':
          description: Bad Request - The request cannot be processed due to invalid syntax.
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ErrorResponseCore260315750'
                - $ref: '#/components/schemas/ErrorResponseCore1243473672'
                - $ref: '#/components/schemas/ErrorResponseCore814179042'
                - $ref: '#/components/schemas/ErrorResponseCore1362235056'
                - $ref: '#/components/schemas/ErrorResponseCore1414382895'
                - $ref: '#/components/schemas/ErrorResponseCore1137512454'
        '403':
          description: Forbidden - The client does not have access rights to the content.
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ErrorResponse403'
      tags:
      - Actions
    servers:
    - url: https://zohoapis.{dc}/crm/{version}
      description: API Server URL
      variables:
        dc:
          description: API Server URL TLD
          default: com
          enum:
          - eu
          - com
          - au
          - in
          - jp
          - cn
          - ca
        version:
          description: API Version
          default: v8
  /{module}/actions/enrol_in_cadences:
    post:
      summary: Enroll records into cadences
      description: API to enroll records into manual cadence
      operationId: postEnrolInCadences
      security:
      - iam-oauth2-schema:
        - ZohoCRM.modules.Leads.CREATE
      - iam-oauth2-schema:
        - ZohoCRM.modules.Contacts.CREATE
      - iam-oauth2-schema:
        - ZohoCRM.modules.Accounts.CREATE
      - iam-oauth2-schema:
        - ZohoCRM.modules.Deals.CREATE
      - iam-oauth2-schema:
        - ZohoCRM.modules.Tasks.CREATE
      - iam-oauth2-schema:
        - ZohoCRM.modules.Events.CREATE
      - iam-oauth2-schema:
        - ZohoCRM.modules.Calls.CREATE
      - iam-oauth2-schema:
        - ZohoCRM.modules.Products.CREATE
      - iam-oauth2-schema:
        - ZohoCRM.modules.Vendors.CREATE
      - iam-oauth2-schema:
        - ZohoCRM.modules.Campaigns.CREATE
      - iam-oauth2-schema:
        - ZohoCRM.modules.Cases.CREATE
      - iam-oauth2-schema:
        - ZohoCRM.modules.Solutions.CREATE
      - iam-oauth2-schema:
        - ZohoCRM.modules.Quotes.CREATE
      - iam-oauth2-schema:
        - ZohoCRM.modules.Invoices.CREATE
      - iam-oauth2-schema:
        - ZohoCRM.modules.Forecasts.CREATE
      - iam-oauth2-schema:
        - ZohoCRM.modules.Activities.CREATE
      - iam-oauth2-schema:
        - ZohoCRM.modules.Notes.CREATE
      - iam-oauth2-schema:
        - ZohoCRM.modules.Attachments.CREATE
      - iam-oauth2-schema:
        - ZohoCRM.modules.custom.CREATE
      parameters:
      - $ref: '#/components/parameters/Module'
      requestBody:
        description: Request body
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostCadencesRequest'
      responses:
        '200':
          description: OK - Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostcadencesResponse200'
        '207':
          description: Multi-Status — Response contains mixed status results
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostcadencesResponse207'
        '400':
          description: Bad Request - The request cannot be processed due to invalid syntax.
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ErrorResponseCore260315750'
                - $ref: '#/components/schemas/ErrorResponseCore1243473672'
                - $ref: '#/components/schemas/ErrorResponseCore814179042'
                - $ref: '#/components/schemas/ErrorResponseCore1362235056'
                - $ref: '#/components/schemas/ErrorResponseCore1414382895'
                - $ref: '#/components/schemas/ErrorResponseCore1137512454'
        '403':
          description: Forbidden - The client does not have access rights to the content.
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ErrorResponse403'
      tags:
      - Actions
    servers:
    - url: https://zohoapis.{dc}/crm/{version}
      description: API Server URL
      variables:
        dc:
          description: API Server URL TLD
          default: com
          enum:
          - eu
          - com
          - au
          - in
          - jp
          - cn
          - ca
        version:
          description: API Version
          default: v8
  /{module}/{record}/actions/change_owner:
    post:
      summary: Change owner for a single record
      description: Updates the owner of a specific record in the module
      operationId: singleUpdate
      parameters:
      - $ref: '#/components/parameters/Module_2'
      - $ref: '#/components/parameters/Record'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              description: Request body for changing the owner of a record
              additionalProperties: false
              properties:
                owner:
                  type: object
                  description: The new owner information
                  additionalProperties: false
                  properties:
                    id:
                      type: string
                      description: The ID of the new owner
                      maxLength: 19
                  required:
                  - id
                notify:
                  type:
                  - boolean
                  - 'null'
                  description: Whether to notify the new owner
                related_modules:
                  type: array
                  description: Related modules to update
                  maxItems: 5
                  items:
                    type: object
                    description: Related module information
                    additionalProperties: false
                    properties:
                      api_name:
                        type: string
                        description: The API name of the related module
                        enum:
                        - Tasks
                        - Events
                        - Calls
                        - Contacts
                        - Deals
                      id:
                        type: string
                        description: The ID of the related module record
                        maxLength: 19
              required:
              - owner
        required: true
      responses:
        '200':
          description: Success response with validation errors
          content:
            application/json:
              schema:
                oneOf:
                - type: object
                  description: Successful owner change response
                  additionalProperties: false
                  properties:
                    code:
                      type: string
                      description: Response code indicating success
                      enum:
                      - SUCCESS
                    details:
                      type: object
                      description: Details of the updated record
                      additionalProperties: false
                      properties:
                        id:
                          type: string
                          description: The ID of the updated record
                          maxLength: 19
                      required:
                      - id
                    message:
                      type: string
                      description: Success message
                      maxLength: 500
                    status:
                      type: string
                      description: Status of the operation
                      enum:
                      - success
                  required:
                  - code
                  - details
                  - message
                  - status
        '400':
          description: Bad Request - Invalid input parameters or unsupported module
          content:
            application/json:
              schema:
                oneOf:
                - type: object
                  description: Error response for unsupported operations or invalid module
                  additionalProperties: false
                  properties:
                    code:
                      type: string
                      description: Error code indicating the type of error
                      enum:
                      - NOT_SUPPORTED
                      - INVALID_DATA
                      - INVALID_MODULE
                    details:
                      type: object
                      description: Additional details about the error
                      additionalProperties: false
                      properties:
                        resource_path_index:
                          type: integer
                          format: int32
                          description: Index of the resource path that caused the error
                      required:
                      - resource_path_index
                    message:
                      type: string
                      description: Error message describing the issue
                      maxLength: 500
                    status:
                      type: string
                      description: Status of the response
                      enum:
                      - error
                  required:
                  - code
                  - details
                  - message
                  - status
                - type: object
                  description: Error response for invalid data or mandatory field not found
                  additionalProperties: false
                  properties:
                    code:
                      type: string
                      description: Error code indicating the type of error
                      enum:
                      - INVALID_DATA
                      - NOT_SUPPORTED
                      - MANDATORY_NOT_FOUND
                    details:
                      type: object
                      description: Additional details about the error
                      additionalProperties: false
                      properties:
                        api_name:
                          type: string
                          description: API name of the field that caused the error
                          maxLength: 200
                        json_path:
                          type: string
                          description: JSON path to the field that caused the error
                          maxLength: 500
                      required:
                      - api_name
                      - json_path
                    message:
                      type: string
                      description: Error message describing the issue
                      maxLength: 500
                    status:
                      type: string
                      description: Status of the response
                      enum:
                      - error
                  required:
                  - code
                  - details
                  - message
                  - status
                - type: object
                  description: Error response for missing expected fields
                  additionalProperties: false
                  properties:
                    code:
                      type: string
                      description: Error code indicating the type of error
                      enum:
                      - EXPECTED_FIELD_MISSING
                    message:
                      type: string
                      description: Error message describing the issue
                      maxLength: 500
                    status:
                      type: string
                      description: Status of the response
                      enum:
                      - error
                    details:
                      type: object
                      description: Details about the missing expected fields
                      additionalProperties: false
                      properties:
                        expected_fields:
                          type: array
                          description: List of expected fields that are missing
                          maxItems: 100
                          items:
                            type: object
                            description: Information about an expected field
                            additionalProperties: false
                            properties:
                              api_name:
                                type: string
                                description: API name of the expected field
                                maxLength: 200
                              json_path:
                                type: string
                                description: JSON path to the expected field
                                maxLength: 500
                            required:
                            - api_name
                            - json_path
                      required:
                      - expected_fields
                  required:
                  - code
                  - message
                  - status
                  - details
                - type: object
                  description: Error response for ambiguous data during processing
                  additionalProperties: false
                  properties:
                    code:
                      type: string
                      description: Error code indicating the type of error
                      enum:
                      - AMBIGUITY_DURING_PROCESSING
                    message:
                      type: string
                      description: Error message describing the issue
                      maxLength: 500
                    status:
                      type: string
                      description: Status of the response
                      enum:
                      - error
                    details:
                      type: object
                      description: Details about the ambiguity
                      additionalProperties: false
                      properties:
                        ambiguity_due_to:
                          type: array
                          description: List of fields causing ambiguity
                          maxItems: 100
                          items:
                            type: object
                            description: Information about a field causing ambiguity
                            additionalProperties: false
                            properties:
                              api_name:
                                type: string
                                description: API name of the field causing ambiguity
                                maxLength: 200
                              json_path:
                                type: string
                                description: JSON path to the field causing ambiguity
                                maxLength: 500
                            required:
                            - api_name
                            - json_path
                      required:
                      - ambiguity_due_to
                  required:
                  - code
                  - message
                  - status
                  - details
        '403':
          description: Forbidden - User does not have permission to perform this operation
          content:
            application/json:
              schema:
                oneOf:
                - type: object
                  description: Error response when user lacks required permissions
                  additionalProperties: false
                  properties:
                    code:
                      type: string
                      description: Error code indicating permission denial
                      enum:
                      - NO_PERMISSION
                    message:
                      type: string
                      description: Error message describing the permission issue
                      maxLength: 500
                    status:
                      type: string
                      description: Status of the response
                      enum:
                      - error
                    details:
                      type: object
                      description: Additional details about missing permissions
                      additionalProperties: false
                      properties:
                        permissions:
                          type: array
                          description: List of required permissions that are missing
                          maxItems: 1
                          items:
                            type: string
                            description: Permission name
                            maxLength: 200
                      required:
                      - permissions
                  required:
                  - code
                  - message
                  - status
                  - details
      security:
      - iam-oauth2-schema:
        - ZohoCRM.change_owner.CREATE
      tags:
      - Actions
    servers:
    - url: https://zohoapis.{dc}/crm/{version}
      description: API Server URL
      variables:
        dc:
          enum:
          - com
          - eu
          - in
          - cn
          - au
          default: com
          description: API Server URL TLD
        version:
          default: v8
          description: API Version
  /{module}/actions/change_owner:
    post:
      summary: Change owner for multiple records
      description: Updates the owner of multiple records in the module
      operationId: bulkChangeOwner
      parameters:
      - $ref: '#/components/parameters/Module_2'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              description: Request body for changing the owner of multiple records
              additionalProperties: false
              properties:
                ids:
                  type: array
                  description: Array of record IDs to change owner
                  maxItems: 500
                  items:
                    type: string
                    description: Record ID
                    maxLength: 19
                owner:
                  type: object
                  description: The new owner information
                  additionalProperties: false
                  properties:
                    id:
                      type: string
                      description: The ID of the new owner
                      maxLength: 19
                  required:
                  - id
                notify:
                  type:
                  - boolean
                  - 'null'
                  description: Whether to notify the new owner
                related_modules:
                  type: array
                  description: Related modules to update
                  maxItems: 5
                  items:
                    type: object
                    description: Related module information
                    additionalProperties: false
                    properties:
                      api_name:
                        type: string
                        description: The API name of the related module
                        enum:
                        - Tasks
                        - Events
                        - Calls
                        - Contacts
                        - Deals
                      id:
                        type: string
                        description: The ID of the related module record
                        maxLength: 19
              required:
              - ids
              - owner
        required: true
      responses:
        '200':
          description: Success response with validation errors
          content:
            application/json:
              schema:
                oneOf:
                - type: object
                  description: Successful owner change response
                  additionalProperties: false
                  properties:
                    code:
                      type: string
                      description: Response code indicating success
                      enum:
                      - SUCCESS
                    details:
                      type: object
                      description: Details of the updated record
                      additionalProperties: false
                      properties:
                        id:
                          type: string
                          description: The ID of the updated record
                          maxLength: 19
                      required:
                      - id
                    message:
                      type: string
                      description: Success message
                      maxLength: 500
                    status:
                      type: string
                      description: Status of the operation
                      enum:
                      - success
                  required:
                  - code
                  - details
                  - message
                  - status
        '400':
          description: Bad Request - Invalid input parameters or unsupported module
          content:
            application/json:
              schema:
                oneOf:
                - type: object
                  description: Error response for unsupported operations or invalid module
                  additionalProperties: false
                  properties:
                    code:
                      type: string
                      description: Error code indicating the type of error
                      enum:
                      - NOT_SUPPORTED
                      - INVALID_DATA
                      - INVALID_MODULE
                    details:
                      type: object
                      description: Additional details about the error
                      additionalProperties: false
                      properties:
                        resource_path_index:
                          type: integer
                          format: int32
                          description: Index of the resource path that caused the error
                      required:
                      - resource_path_index
                    message:
                      type: string
                      description: Error message describing the issue
                      maxLength: 500
                    status:
                      type: string
                      description: Status of the response
                      enum:
                      - error
                  required:
                  - code
                  - details
                  - message
                  - status
                - type: object
                  description: Error response for invalid data or mandatory field not found
                  additionalProperties: false
                  properties:
                    code:
                      type: string
                      description: Error code indicating the type of error
                      enum:
                      - INVALID_DATA
                      - NOT_SUPPORTED
                      - MANDATORY_NOT_FOUND
                    details:
                      type: object
                      description: Additional details about the error
                      additionalProperties: false
                      properties:
                        api_name:
                          type: string
                          description: API name of the field that caused the error
                          maxLength: 200
                        json_path:
                          type: string
                          description: JSON path to the field that caused the error
                          maxLength: 500
                      required:
                      - api_name
                      - json_path
                    message:
                      type: string
                      description: Error message describing the issue
                      maxLength: 500
                    status:
                      type: string
                      description: Status of the response
                      enum:
                      - error
                  required:
                  - code
                  - details
                  - message
                  - status
                - type: object
                  description: Error response for missing expected fields
                  additionalProperties: false
                  properties:
                    code:
                      type: string
                      description: Error code indicating the type of error
                      enum:
                      - EXPECTED_FIELD_MISSING
                    message:
                      type: string
                      description: Error message describing the issue
                      maxLength: 500
                    status:
                      type: string
                      description: Status of the response
                      enum:
                      - error
                    details:
                      type: object
                      description: Details about the missing expected fields
                      additionalProperties: false
                      properties:
                        expected_fields:
                          type: array
                          description: List of expected fields that are missing
                          maxItems: 100
                          items:
                            type: object
                            description: Information about an expected field
                            additionalProperties: false
                            properties:
                              api_name:
                                type: string
                                description: API name of the expected field
                                maxLength: 200
                              json_path:
                                type: string
                                descrip

# --- truncated at 32 KB (539 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zoho-crm/refs/heads/main/openapi/zoho-crm-actions-api-openapi.yml