Zoho

Zoho Events API

The Events API from Zoho — 1 operation(s) for events.

GitHub OpenAPI

Documentation

📖
Documentation
https://www.zoho.com/crm/developer/docs/api/
📖
APIReference
https://www.zoho.com/crm/developer/docs/api/v8/
📖
GettingStarted
https://www.zoho.com/crm/developer/docs/
📖
Documentation
https://desk.zoho.com/DeskAPIDocument
📖
Documentation
https://www.zoho.com/analytics/api/v2/introduction.html
📖
APIReference
https://www.zoho.com/analytics/api/v2/
📖
Documentation
https://www.bigin.com/developer/docs/apis/v2/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/zoho/refs/heads/main/openapi/zoho-events-api-openapi.yml

Code Examples

💻
CodeExamples
https://github.com/zoho/ZohoDesk-PortalSDK-Sample-apps-iOS
💻
CodeExamples
https://github.com/zoho/ZohoDesk-PortalSDK-sample-apps-android
💻
CodeExamples
https://github.com/zoho/ZohoDesk-PortalSDK-sample-apps-flutter
💻
CodeExamples
https://github.com/zoho/ZohoDesk-PortalSDK-sample-apps-reactnative
💻
CodeExamples
https://github.com/zoho/Zoho-Desk-ASAP-Mobile-SDK-API-Samples
💻
CodeExamples
https://github.com/zoho/analytics-codestudio

Other Resources

🔗
SDKs
https://packagist.org/packages/zohocrm/php-sdk-8.0
🔗
SDKs
https://pypi.org/project/zohocrmsdk8-0/
🔗
SDKs
https://www.nuget.org/packages/ZOHOCRMSDK-8.0/
🔗
SDKs
https://github.com/zoho/zohocrm-java-sdk-8.0
🔗
SDKs
https://www.npmjs.com/package/@zohocrm/nodejs-sdk-8.0
🔗
SDKs
https://www.npmjs.com/package/@zohocrm/typescript-sdk-8.0
🔗
SDKs
https://rubygems.org/gems/ZOHOCRMSDK8_0
🔗
SDKs
https://github.com/zoho/zohocrm-javascript-sdk-8.0
🔗
SDKs
https://github.com/zoho/zohocrm-scala-sdk-8.0
🔗
SDKs
https://cocoapods.org/pods/ZCRMiOS
🔗
DeveloperPortal
https://www.zoho.com/desk/developers/
🔗
SDKs
https://github.com/zoho/ZohoDeskPortalSDK
🔗
SDKs
https://github.com/zoho/react-native-zohodesk-portal-sdk
🔗
SDKs
https://github.com/zoho/zdesk-asap-flutter
🔗
SDKs
https://github.com/zoho/cordova-plugin-zohodesk-portal
🔗
Tools
https://github.com/zoho/analytics-mcp-server
🔗
Integrations
https://github.com/zoho/analytics-dataiku-import-plugin
🔗
Integrations
https://github.com/zoho/analytics-dataiku-export-plugin
🔗
DeveloperPortal
https://www.bigin.com/developer-center.html

OpenAPI Specification

zoho-events-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Helpcenter Events API
  version: 1.0.0
tags:
- name: Events
paths:
  /Events/{event}/actions/cancel:
    post:
      summary: Cancel Meeting
      operationId: cancelMeetings
      description: To post the cancelMeeting mail
      parameters:
      - $ref: '#/components/parameters/Event'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              description: Contains Data properties
              properties:
                data:
                  type: array
                  description: Data contains whether to send meeting cancellation notification or not
                  maxItems: 10
                  items:
                    type: object
                    additionalProperties: false
                    description: Data Properties
                    properties:
                      send_cancelling_mail:
                        type: boolean
                        description: Mention whether to send meeting cancellation notification mail to participants or not.
                    required:
                    - send_cancelling_mail
              required:
              - data
        required: true
      responses:
        '200':
          description: The event is successfully cancelled
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                description: Contains success response data
                properties:
                  data:
                    type: array
                    description: Contains success response data
                    maxItems: 10
                    items:
                      type: object
                      additionalProperties: false
                      description: Success response Properties
                      properties:
                        code:
                          type: string
                          description: Success Code
                          enum:
                          - SUCCESS
                        message:
                          type: string
                          description: Success Message
                          maxLength: 255
                        status:
                          type: string
                          description: Success Status
                          enum:
                          - success
                        details:
                          type: object
                          additionalProperties: false
                          description: Contains Cancel meeting's ID
                          properties:
                            id:
                              type: string
                              description: Detail_field - ID
                              maxLength: 255
                          required:
                          - id
                      required:
                      - code
                      - message
                      - status
                      - details
                required:
                - data
        '400':
          description: The server cannot process the request because it contains invalid parameters or malformed data.
          content:
            application/json:
              schema:
                description: Possible errors
                oneOf:
                - type: object
                  additionalProperties: false
                  description: The request method is incorrect.Use the HTTP POST method to make this API call. Any other request method will result in this error.
                  properties:
                    code:
                      type: string
                      description: Error code
                      enum:
                      - INVALID_REQUEST_METHOD
                    message:
                      type: string
                      description: Error message
                      maxLength: 255
                    details:
                      type: object
                      additionalProperties: false
                      description: Error details
                    status:
                      type: string
                      description: Error Status
                      enum:
                      - error
                  required:
                  - code
                  - message
                  - details
                  - status
                - type: object
                  additionalProperties: false
                  description: Required field not found! You have not specified the send_cancelling_mail key in the input body. Specify the mandatory key.
                  properties:
                    code:
                      type: string
                      description: Error code
                      enum:
                      - MANDATORY_NOT_FOUND
                    message:
                      type: string
                      description: Error message
                      maxLength: 255
                    details:
                      type: object
                      additionalProperties: false
                      description: Error details
                      properties:
                        api_name:
                          type: string
                          description: Detail_field - api_name
                          maxLength: 255
                        json_path:
                          type: string
                          description: Detail_field - json_path
                          maxLength: 255
                      required:
                      - api_name
                      - json_path
                    status:
                      type: string
                      description: Error Status
                      enum:
                      - error
                  required:
                  - code
                  - message
                  - details
                  - status
                - type: object
                  additionalProperties: false
                  description: The id given seems to be invalid! Specify a valid Meeting ID.
                  properties:
                    code:
                      type: string
                      description: Error code
                      enum:
                      - INVALID_DATA
                    message:
                      type: string
                      description: Error message
                      maxLength: 255
                    details:
                      type: object
                      additionalProperties: false
                      description: Error details
                      properties:
                        api_name:
                          type: string
                          description: Detail_field - api_name
                          maxLength: 255
                        json_path:
                          type: string
                          description: Detail_field - json_path
                          maxLength: 255
                      required:
                      - api_name
                      - json_path
                    status:
                      type: string
                      description: Error Status
                      enum:
                      - error
                  required:
                  - code
                  - message
                  - details
                  - status
                - type: object
                  additionalProperties: false
                  description: The event is already cancelled. You are trying to cancel a meeting that is already cancelled. Specify a valid Meeting ID.
                  properties:
                    code:
                      type: string
                      description: Error code
                      enum:
                      - NOT_ALLOWED
                    message:
                      type: string
                      description: Error message
                      maxLength: 255
                    details:
                      type: object
                      additionalProperties: false
                      description: Error details
                    status:
                      type: string
                      description: Error Status
                      enum:
                      - error
                  required:
                  - code
                  - message
                  - details
                  - status
                - type: object
                  additionalProperties: false
                  description: You cannot cancel the event without inviting participants. A meeting without participants cannot be cancelled. Invite participants to the meeting and cancel the meeting, or specify a Meeting ID with participants.
                  properties:
                    code:
                      type: string
                      description: Error code
                      enum:
                      - NOT_ALLOWED
                    message:
                      type: string
                      description: Error message
                      maxLength: 255
                    details:
                      type: object
                      additionalProperties: false
                      description: Error details
                    status:
                      type: string
                      description: Error Status
                      enum:
                      - error
                  required:
                  - code
                  - message
                  - details
                  - status
                - type: object
                  additionalProperties: false
                  description: You cannot cancel the meeting after the meeting end time. A meeting cannot be cancelled after the meeting end time. Specify a valid Meeting ID.
                  properties:
                    code:
                      type: string
                      description: Error code
                      enum:
                      - NOT_ALLOWED
                    message:
                      type: string
                      description: Error message
                      maxLength: 255
                    details:
                      type: object
                      additionalProperties: false
                      description: Error details
                    status:
                      type: string
                      description: Error Status
                      enum:
                      - error
                  required:
                  - code
                  - message
                  - details
                  - status
                - type: object
                  additionalProperties: false
                  description: No permission to perform an action on this record. The user does not have permission to access the record. Contact your system administrator.
                  properties:
                    code:
                      type: string
                      description: Error code
                      enum:
                      - CANNOT_PERFORM_ACTION
                    message:
                      type: string
                      description: Error message
                      maxLength: 255
                    details:
                      type: object
                      additionalProperties: false
                      description: Error details
                    status:
                      type: string
                      description: Error Status
                      enum:
                      - error
                  required:
                  - code
                  - message
                  - details
                  - status
                - type: object
                  additionalProperties: false
                  description: permission denied. The user does not have permission to cancel the meeting. Contact your system administrator.
                  properties:
                    code:
                      type: string
                      description: Error code
                      enum:
                      - NO_PERMISSION
                    message:
                      type: string
                      description: Error message
                      maxLength: 255
                    details:
                      type: object
                      additionalProperties: false
                      description: Error details
                    status:
                      type: string
                      description: Error Status
                      enum:
                      - error
                  required:
                  - code
                  - message
                  - details
                  - status
                - type: object
                  additionalProperties: false
                  description: Daily limit reached. The user has reached the daily mail limit. No more emails can be sent. You can choose not to send the cancellation email, or cancel the meeting the next day.
                  properties:
                    code:
                      type: string
                      description: Error code
                      enum:
                      - DAILY_LIMIT_EXCEEDED
                    message:
                      type: string
                      description: Error message
                      maxLength: 255
                    details:
                      type: object
                      additionalProperties: false
                      description: Error details
                    status:
                      type: string
                      description: Error Status
                      enum:
                      - error
                  required:
                  - code
                  - message
                  - details
                  - status
        '401':
          description: Unauthorized – Invalid or expired token.
          content:
            application/json:
              schema:
                oneOf:
                - type: object
                  additionalProperties: false
                  description: The access token you have used to make this API call does not have the required scope. Generate a new access token with the required scopes for this API.
                  properties:
                    code:
                      type: string
                      description: Error code
                      enum:
                      - OAUTH_SCOPE_MISMATCH
                    message:
                      type: string
                      description: Error message
                      maxLength: 255
                    details:
                      type: object
                      additionalProperties: false
                      description: Error details
                    status:
                      type: string
                      description: Error Status
                      enum:
                      - error
                  required:
                  - code
                  - message
                  - details
                  - status
        '404':
          description: Unauthorized – Invalid or expired token.
          content:
            application/json:
              schema:
                oneOf:
                - type: object
                  additionalProperties: false
                  description: The request URL is incorrect.
                  properties:
                    code:
                      type: string
                      description: Error code
                      enum:
                      - INVALID_URL_PATTERN
                    message:
                      type: string
                      description: Error message
                      maxLength: 255
                    details:
                      type: object
                      additionalProperties: false
                      description: Error details
                    status:
                      type: string
                      description: Error Status
                      enum:
                      - error
                  required:
                  - code
                  - message
                  - details
                  - status
      security:
      - iam-oauth2-schema:
        - ZohoCRM.Modules.Events.update
      tags:
      - Events
components:
  parameters:
    Event:
      name: event
      in: path
      required: true
      schema:
        type: string
        maxLength: 255
      description: This refers to the Event's id that need to be cancel
  securitySchemes:
    iam-oauth2-schema:
      $ref: ./Common.json#/components/securitySchemes/iam-oauth2-schema
x-entity: Helpcenter