Zoho

Zoho TicketApprovals API

The TicketApprovals API from Zoho — 2 operation(s) for ticketapprovals.

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-ticketapprovals-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-ticketapprovals-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Helpcenter TicketApprovals API
  version: 1.0.0
tags:
- name: TicketApprovals
paths:
  /api/v1/tickets/{ticketId}/approvals:
    get:
      tags:
      - TicketApprovals
      summary: List approvals
      description: This API lists the approvals submitted in your help desk.
      operationId: getTicketApprovals
      parameters:
      - $ref: '#/components/parameters/ticketId'
      - $ref: ./Common.json#/components/parameters/orgId
      responses:
        '422':
          $ref: ./Common.json#/components/responses/multipleUnprocessEntityResponse
        '200':
          $ref: '#/components/responses/listApprovalsResponse'
      security:
      - iam-oauth2-schema:
        - Desk.tickets.READ
      x-audience:
      - external-public
    post:
      tags:
      - TicketApprovals
      summary: Create approval
      description: This API creates an approval in your help desk.
      operationId: createTicketApproval
      parameters:
      - $ref: '#/components/parameters/ticketId'
      - $ref: ./Common.json#/components/parameters/orgId
      requestBody:
        $ref: '#/components/requestBodies/addApproval'
      responses:
        '422':
          $ref: ./Common.json#/components/responses/multipleUnprocessEntityResponse
        '200':
          $ref: '#/components/responses/addApprovalResponse'
      security:
      - iam-oauth2-schema:
        - Desk.tickets.CREATE
      x-audience:
      - external-public
  /api/v1/tickets/{ticketId}/approvals/{approvalId}:
    get:
      tags:
      - TicketApprovals
      summary: Get approval
      description: This API fetches the details of an approval.
      operationId: getTicketApproval
      parameters:
      - $ref: '#/components/parameters/approvalId'
      - $ref: '#/components/parameters/ticketId'
      - $ref: ./Common.json#/components/parameters/orgId
      responses:
        '200':
          $ref: '#/components/responses/getApprovalResponse'
      security:
      - iam-oauth2-schema:
        - Desk.tickets.READ
      x-audience:
      - external-public
    patch:
      tags:
      - TicketApprovals
      summary: Update approval
      description: This API updates the details of an existing ticket approval.
      operationId: updateTicketApproval
      parameters:
      - $ref: '#/components/parameters/approvalId'
      - $ref: '#/components/parameters/ticketId'
      - $ref: ./Common.json#/components/parameters/orgId
      requestBody:
        $ref: '#/components/requestBodies/updateApproval'
      responses:
        '422':
          $ref: ./Common.json#/components/responses/multipleUnprocessEntityResponse
        '500':
          $ref: ./Common.json#/components/responses/internalErrorResponse
        '200':
          $ref: '#/components/responses/updateApprovalResponse'
      security:
      - iam-oauth2-schema:
        - Desk.tickets.UPDATE
      x-audience:
      - external-public
components:
  parameters:
    approvalId:
      name: approvalId
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type:
        - string
        - 'null'
        - integer
        format: int64
        pattern: ([0-9]+)
    ticketId:
      name: ticketId
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type:
        - string
        - 'null'
        - integer
        format: int64
        pattern: ([0-9]+)
  requestBodies:
    updateApproval:
      content:
        application/json:
          schema:
            type:
            - 'null'
            - object
            additionalProperties: false
            properties:
              status:
                type:
                - string
                - 'null'
                enum:
                - Approved
                - Rejected
                maxLength: 100
                minLength: 0
            required:
            - status
          examples:
            Valid requestBody Definitions:
              value:
                status: Approved/Rejected
    addApproval:
      content:
        application/json:
          schema:
            type:
            - 'null'
            - object
            additionalProperties: false
            properties:
              approverIds:
                type:
                - 'null'
                - array
                items:
                  type:
                  - string
                  - 'null'
                  - integer
                  format: int64
                  pattern: ([0-9]+)
                uniqueItems: true
              subject:
                type:
                - string
                - 'null'
                maxLength: 1000
                minLength: 0
              description:
                type:
                - string
                - 'null'
                maxLength: 65535
                minLength: 0
            required:
            - approverIds
            - subject
          examples:
            Valid requestBody Definitions:
              value:
                approverIds:
                - '1892000000042001'
                subject: New approval
                description: new app desc
  responses:
    getApprovalResponse:
      description: getApprovalResponse template definitions
      content:
        application/json:
          schema:
            oneOf:
            - type:
              - 'null'
              - object
              additionalProperties: false
              properties:
                approver:
                  $ref: ./TicketApprovals.json#/components/schemas/approvalActor
                requester:
                  $ref: ./TicketApprovals.json#/components/schemas/approvalActor
                requestedTime:
                  type:
                  - string
                  - 'null'
                  maxLength: 100
                  minLength: 0
                  pattern: '[a-zA-Z_/\-\+0-9]*'
                subject:
                  type:
                  - string
                  - 'null'
                  maxLength: 1000
                  minLength: 0
                description:
                  type:
                  - string
                  - 'null'
                  maxLength: 65535
                  minLength: 0
                id:
                  type:
                  - string
                  - 'null'
                  - integer
                  format: int64
                  pattern: ([0-9]+)
                status:
                  type:
                  - string
                  - 'null'
                  enum:
                  - Approved
                  - Rejected
                  - Pending
                  maxLength: 100
                  minLength: 0
                processedTime:
                  type:
                  - string
                  - 'null'
                  maxLength: 100
                  minLength: 0
                  pattern: '[a-zA-Z_/\-\+0-9]*'
              required:
              - approver
              - description
              - id
              - processedTime
              - requestedTime
              - requester
              - status
              - subject
            - type:
              - 'null'
              - object
              additionalProperties: false
              properties:
                errorCode:
                  type:
                  - string
                  - 'null'
                  enum:
                  - URL_NOT_FOUND
                  - UNAUTHORIZED
                  - INVALID_OAUTH
                  - SCOPE_MISMATCH
                  - FORBIDDEN
                  - LICENSE_ACCESS_LIMITED
                  - METHOD_NOT_ALLOWED
                  - RESOURCE_SIZE_EXCEEDED
                  - UNSUPPORTED_MEDIA_TYPE
                  - INVALID_DATA
                  - UNPROCESSABLE_ENTITY
                  - ONLY_LIVECHAT_USER
                  - INTEGRATION_ADMIN_ERROR
                  - THRESHOLD_EXCEEDED
                  - INTERNAL_SERVER_ERROR
                  - EMPTY_PAYLOAD
                  maxLength: 100
                  minLength: 0
                message:
                  type:
                  - string
                  - 'null'
                  maxLength: 255
                  minLength: 0
              required:
              - errorCode
              - message
          examples:
            Valid responses Definitions:
              value:
                approver:
                  firstName: saran
                  lastName: raj
                  photoUrl: https://desk.zoho.com/api/v1/agent/4000000015001/photo
                  id: '4000000015001'
                  email: null
                requester:
                  firstName: aravind
                  lastName: a
                  photoUrl: https://desk.zoho.com/api/v1/agent/4000000012629/photo
                  id: '4000000012629'
                  email: null
                requestedTime: 1466514974000
                subject: Testing
                'processedTime ': 1517998355000
                description: testing
                id: '1892000001054081'
                status: Rejected
    updateApprovalResponse:
      description: updateApprovalResponse template definitions
      content:
        application/json:
          schema:
            oneOf:
            - type:
              - 'null'
              - object
              additionalProperties: false
              properties:
                approver:
                  $ref: ./TicketApprovals.json#/components/schemas/approvalActor
                requester:
                  $ref: ./TicketApprovals.json#/components/schemas/approvalActor
                requestedTime:
                  type:
                  - string
                  - 'null'
                  maxLength: 100
                  minLength: 0
                  pattern: '[a-zA-Z_/\-\+0-9]*'
                subject:
                  type:
                  - string
                  - 'null'
                  maxLength: 1000
                  minLength: 0
                description:
                  type:
                  - string
                  - 'null'
                  maxLength: 65535
                  minLength: 0
                id:
                  type:
                  - string
                  - 'null'
                  - integer
                  format: int64
                  pattern: ([0-9]+)
                status:
                  type:
                  - string
                  - 'null'
                  enum:
                  - Approved
                  - Rejected
                  - Pending
                  maxLength: 100
                  minLength: 0
                processedTime:
                  type:
                  - string
                  - 'null'
                  maxLength: 100
                  minLength: 0
                  pattern: '[a-zA-Z_/\-\+0-9]*'
              required:
              - approver
              - description
              - id
              - processedTime
              - requestedTime
              - requester
              - status
              - subject
            - type:
              - 'null'
              - object
              additionalProperties: false
              properties:
                errorCode:
                  type:
                  - string
                  - 'null'
                  enum:
                  - URL_NOT_FOUND
                  - UNAUTHORIZED
                  - INVALID_OAUTH
                  - SCOPE_MISMATCH
                  - FORBIDDEN
                  - LICENSE_ACCESS_LIMITED
                  - METHOD_NOT_ALLOWED
                  - RESOURCE_SIZE_EXCEEDED
                  - UNSUPPORTED_MEDIA_TYPE
                  - INVALID_DATA
                  - UNPROCESSABLE_ENTITY
                  - ONLY_LIVECHAT_USER
                  - INTEGRATION_ADMIN_ERROR
                  - THRESHOLD_EXCEEDED
                  - INTERNAL_SERVER_ERROR
                  - EMPTY_PAYLOAD
                  maxLength: 100
                  minLength: 0
                message:
                  type:
                  - string
                  - 'null'
                  maxLength: 255
                  minLength: 0
              required:
              - errorCode
              - message
          examples:
            Valid responses Definitions:
              value:
                approver:
                  firstName: saran
                  lastName: raj
                  photoUrl: https://desk.zoho.com/api/v1/agent/4000000015001/photo
                  id: '4000000015001'
                  email: null
                requester:
                  firstName: aravind
                  lastName: a
                  photoUrl: https://desk.zoho.com/api/v1/agent/4000000012629/photo
                  id: '4000000012629'
                  email: null
                requesterId: '1892000000042001'
                requestedTime: 1466514974000
                approverId: '1892000000042001'
                subject: Testing
                description: testing
                id: '1892000001054081'
                status: Approved
                processedTime: 1517998355000
    addApprovalResponse:
      description: addApprovalResponse template definitions
      content:
        application/json:
          schema:
            oneOf:
            - type:
              - 'null'
              - object
              additionalProperties: false
              properties:
                approvals:
                  $ref: ./TicketApprovals.json#/components/schemas/listApprovalsData
              required:
              - approvals
            - type:
              - 'null'
              - object
              additionalProperties: false
              properties:
                errorCode:
                  type:
                  - string
                  - 'null'
                  enum:
                  - URL_NOT_FOUND
                  - UNAUTHORIZED
                  - INVALID_OAUTH
                  - SCOPE_MISMATCH
                  - FORBIDDEN
                  - LICENSE_ACCESS_LIMITED
                  - METHOD_NOT_ALLOWED
                  - RESOURCE_SIZE_EXCEEDED
                  - UNSUPPORTED_MEDIA_TYPE
                  - INVALID_DATA
                  - UNPROCESSABLE_ENTITY
                  - ONLY_LIVECHAT_USER
                  - INTEGRATION_ADMIN_ERROR
                  - THRESHOLD_EXCEEDED
                  - INTERNAL_SERVER_ERROR
                  - EMPTY_PAYLOAD
                  maxLength: 100
                  minLength: 0
                message:
                  type:
                  - string
                  - 'null'
                  maxLength: 255
                  minLength: 0
              required:
              - errorCode
              - message
          examples:
            Valid responses Definitions:
              value:
                approvals:
                - approver:
                    firstName: saran
                    lastName: raj
                    photoUrl: https://desk.zoho.com/api/v1/agent/4000000015001/photo
                    id: '4000000015001'
                    email: null
                  requester:
                    firstName: aravind
                    lastName: a
                    photoUrl: https://desk.zoho.com/api/v1/agent/4000000012629/photo
                    id: '4000000012629'
                    email: null
                  requestedTime: 1466514974000
                  subject: Testing
                  description: testing
                  id: '1892000001054081'
                  status: PENDING
                  processedTime: null
    listApprovalsResponse:
      description: listApprovalsResponse template definitions
      content:
        application/json:
          schema:
            oneOf:
            - type:
              - 'null'
              - object
              additionalProperties: false
              properties:
                data:
                  $ref: ./TicketApprovals.json#/components/schemas/listApprovalsData
              required:
              - data
            - type:
              - 'null'
              - object
              additionalProperties: false
              properties:
                errorCode:
                  type:
                  - string
                  - 'null'
                  enum:
                  - URL_NOT_FOUND
                  - UNAUTHORIZED
                  - INVALID_OAUTH
                  - SCOPE_MISMATCH
                  - FORBIDDEN
                  - LICENSE_ACCESS_LIMITED
                  - METHOD_NOT_ALLOWED
                  - RESOURCE_SIZE_EXCEEDED
                  - UNSUPPORTED_MEDIA_TYPE
                  - INVALID_DATA
                  - UNPROCESSABLE_ENTITY
                  - ONLY_LIVECHAT_USER
                  - INTEGRATION_ADMIN_ERROR
                  - THRESHOLD_EXCEEDED
                  - INTERNAL_SERVER_ERROR
                  - EMPTY_PAYLOAD
                  maxLength: 100
                  minLength: 0
                message:
                  type:
                  - string
                  - 'null'
                  maxLength: 255
                  minLength: 0
              required:
              - errorCode
              - message
          examples:
            Valid responses Definitions:
              value:
                data:
                - approver:
                    firstName: ''
                    lastName: raj
                    photoUrl: https://desk.zoho.com/api/v1/agent/4000000015001/photo
                    id: '4000000015001'
                    email: carol@zylker.com
                  requester:
                    firstName: ''
                    lastName: saran
                    photoUrl: https://desk.zoho.com/api/v1/agent/4000000012629/photo
                    id: '4000000012629'
                    email: carol@zylker.com
                  requestedTime: 1466514974000
                  subject: Testing
                  description: testing
                  id: '1892000001054081'
                  status: Approved
                  processedTime: 1517998355000
  securitySchemes:
    iam-oauth2-schema:
      $ref: ./Common.json#/components/securitySchemes/iam-oauth2-schema
x-entity: Helpcenter