Zoho

Zoho Photo API

The Photo API from Zoho — 1 operation(s) for photo.

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-photo-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-photo-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Helpcenter Photo API
  version: 1.0.0
tags:
- name: Photo
paths:
  /{module}/{record}/photo:
    get:
      summary: Get a photo
      description: Retrieve a photo for a record
      operationId: getPhoto
      parameters:
      - $ref: '#/components/parameters/Module'
      - $ref: '#/components/parameters/Record'
      responses:
        '200':
          description: Successfully retrieved the photo
          content:
            image/png:
              schema:
                type: string
                format: binary
                description: Binary image data representing the record photo
        '204':
          description: No photo found for the record
        '400':
          description: Bad request - Invalid URL pattern, data, or module
          content:
            application/json:
              schema:
                type: object
                description: Error response object
                additionalProperties: false
                properties:
                  code:
                    type: string
                    description: Error code indicating the type of error
                    enum:
                    - INVALID_URL_PATTERN
                    - INVALID_DATA
                    - INVALID_MODULE
                  message:
                    type: string
                    description: Error message describing the error
                    maxLength: 1000
                  status:
                    type: string
                    description: Status of the response
                    enum:
                    - error
                  details:
                    oneOf:
                    - type: object
                      description: Empty details object
                      additionalProperties: false
                    - type: object
                      description: Details object containing invalid ID
                      additionalProperties: false
                      properties:
                        id:
                          type: string
                          description: The invalid ID
                          maxLength: 100
                      required:
                      - id
                    - type: object
                      description: Details object containing resource path index
                      additionalProperties: false
                      properties:
                        resource_path_index:
                          type: integer
                          format: int32
                          description: Index of the invalid resource path
                      required:
                      - resource_path_index
                required:
                - code
                - message
                - status
                - details
      security:
      - iam-oauth2-schema:
        - ZohoCRM.modules.READ
      tags:
      - Photo
    post:
      summary: Upload a photo
      description: Upload a photo for a record
      operationId: uploadPhoto
      parameters:
      - $ref: '#/components/parameters/Module'
      - $ref: '#/components/parameters/Record'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              description: Request body for uploading a photo file
              additionalProperties: false
              properties:
                file:
                  type: string
                  format: binary
                  description: The photo file to upload
              required:
              - file
        required: true
      responses:
        '200':
          description: Successfully uploaded the photo
          content:
            application/json:
              schema:
                type: object
                description: Success response object
                additionalProperties: false
                properties:
                  code:
                    type: string
                    description: Success code indicating the operation completed successfully
                    enum:
                    - SUCCESS
                  message:
                    type: string
                    description: Success message describing the result
                    maxLength: 1000
                  status:
                    type: string
                    description: Status of the response
                    enum:
                    - success
                  details:
                    type: object
                    description: Additional details about the operation
                    additionalProperties: false
                required:
                - code
                - message
                - status
                - details
        '400':
          description: Bad request - Invalid URL pattern, data, or module
          content:
            application/json:
              schema:
                description: Error response for photo upload operation
                oneOf:
                - type: object
                  description: Error response object
                  additionalProperties: false
                  properties:
                    code:
                      type: string
                      description: Error code indicating the type of error
                      enum:
                      - INVALID_URL_PATTERN
                      - INVALID_DATA
                      - INVALID_MODULE
                      - CANNOT_PERFORM_ACTION
                      - NOT_REVIEWED
                      - NOT_APPROVED
                      - RECORD_LOCKED
                    message:
                      type: string
                      description: Error message describing the error
                      maxLength: 1000
                    status:
                      type: string
                      description: Status of the response
                      enum:
                      - error
                    details:
                      oneOf:
                      - type: object
                        description: Empty details object
                        additionalProperties: false
                      - type: object
                        description: Details object containing invalid ID
                        additionalProperties: false
                        properties:
                          id:
                            type: string
                            description: The invalid ID
                            maxLength: 100
                        required:
                        - id
                      - type: object
                        description: Details object containing resource path index
                        additionalProperties: false
                        properties:
                          resource_path_index:
                            type: integer
                            format: int32
                            description: Index of the invalid resource path
                        required:
                        - resource_path_index
                  required:
                  - code
                  - message
                  - status
                  - details
      security:
      - iam-oauth2-schema:
        - ZohoCRM.modules.CREATE
      tags:
      - Photo
    delete:
      summary: Delete a photo
      description: Delete a photo for a record
      operationId: deletePhoto
      parameters:
      - $ref: '#/components/parameters/Module'
      - $ref: '#/components/parameters/Record'
      responses:
        '200':
          description: Successfully deleted the photo
          content:
            application/json:
              schema:
                type: object
                description: Success response object
                additionalProperties: false
                properties:
                  code:
                    type: string
                    description: Success code indicating the operation completed successfully
                    enum:
                    - SUCCESS
                  message:
                    type: string
                    description: Success message describing the result
                    maxLength: 1000
                  status:
                    type: string
                    description: Status of the response
                    enum:
                    - success
                  details:
                    type: object
                    description: Additional details about the operation
                    additionalProperties: false
                required:
                - code
                - message
                - status
                - details
        '400':
          description: Bad request - Invalid URL pattern, data, or module
          content:
            application/json:
              schema:
                description: Error response for photo delete operation
                oneOf:
                - type: object
                  description: Error response object
                  additionalProperties: false
                  properties:
                    code:
                      type: string
                      description: Error code indicating the type of error
                      enum:
                      - INVALID_URL_PATTERN
                      - INVALID_DATA
                      - INVALID_MODULE
                    message:
                      type: string
                      description: Error message describing the error
                      maxLength: 1000
                    status:
                      type: string
                      description: Status of the response
                      enum:
                      - error
                    details:
                      oneOf:
                      - type: object
                        description: Empty details object
                        additionalProperties: false
                      - type: object
                        description: Details object containing invalid ID
                        additionalProperties: false
                        properties:
                          id:
                            type: string
                            description: The invalid ID
                            maxLength: 100
                        required:
                        - id
                      - type: object
                        description: Details object containing resource path index
                        additionalProperties: false
                        properties:
                          resource_path_index:
                            type: integer
                            format: int32
                            description: Index of the invalid resource path
                        required:
                        - resource_path_index
                  required:
                  - code
                  - message
                  - status
                  - details
      security:
      - iam-oauth2-schema:
        - ZohoCRM.modules.DELETE
      tags:
      - Photo
components:
  parameters:
    Module:
      name: module
      in: path
      required: true
      description: The API name of the module
      schema:
        type: string
        maxLength: 100
    Record:
      name: record
      in: path
      required: true
      description: The record ID
      schema:
        type: string
        format: int64
        maxLength: 20
  securitySchemes:
    iam-oauth2-schema:
      $ref: ./Common.json#/components/securitySchemes/iam-oauth2-schema
x-entity: Helpcenter