Zoho

Zoho Contacts API

The Contacts API from Zoho — 4 operation(s) for contacts.

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-contacts-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-contacts-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Helpcenter Contacts API
  version: 1.0.0
tags:
- name: Contacts
paths:
  /Contacts/{contactId}/Emails/actions/link_record:
    post:
      security:
      - iam-oauth2-schema:
        - ZohoCRM.modules.emails.CREATE
        - ZohoCRM.modules.deals.CREATE
        - ZohoCRM.modules.contacts.CREATE
      summary: Link Emails to Deals
      description: Links the emails to the specified deals in CRM.
      operationId: linkEmailsToDeals
      parameters:
      - $ref: '#/components/parameters/ContactId'
      requestBody:
        description: Request body
        content:
          application/json:
            schema:
              description: Request body schema
              additionalProperties: false
              type: object
              properties:
                Emails:
                  description: List of emails to be linked to deals
                  type: array
                  maxItems: 20
                  items:
                    description: Email link details
                    additionalProperties: false
                    type: object
                    properties:
                      message_id:
                        description: Unique identifier of the email message
                        type: string
                        enum:
                        - fa3efd2e3d21c63dfb3a1ead81cfbcac3428b9eb290577709d7f12289b5aa1bf5b2bd0f6744144c7a9aae67068ccdc7f
                      owner:
                        description: Owner of the email
                        additionalProperties: false
                        type: object
                        properties:
                          id:
                            description: Unique identifier of the owner
                            type: string
                            enum:
                            - '1238016000000362001'
                      linked_record:
                        description: Details of the record to which the email is to be linked
                        additionalProperties: false
                        type: object
                        properties:
                          module:
                            description: Module information
                            additionalProperties: false
                            type: object
                            properties:
                              api_name:
                                description: API name of the module
                                type: string
                                enum:
                                - Deals
                              id:
                                description: ' Unique identifier of the module'
                                type: string
                                enum:
                                - '1238016000000000131'
                            required:
                            - id
                          name:
                            description: Name of the linked record
                            type: string
                            enum:
                            - Sai Deal
                          id:
                            description: Unique identifier of the linked record
                            type: string
                            enum:
                            - '1238016000000514024'
                            - '1238016000000002676'
                        required:
                        - module
                        - id
                    required:
                    - message_id
                    - owner
                    - linked_record
        required: true
      responses:
        '200':
          description: success response
          content:
            application/json:
              schema:
                description: Response schema
                additionalProperties: false
                type: object
                properties:
                  Emails:
                    description: List of email link operation results
                    maxItems: 20
                    type: array
                    items:
                      additionalProperties: false
                      description: Email link operation result
                      type: object
                      properties:
                        status:
                          description: Status of the link operation
                          type: string
                          enum:
                          - success
                        code:
                          description: Result code of the link operation
                          type: string
                          enum:
                          - SUCCESS
                        message:
                          description: Detailed message about the link operation
                          type: string
                          maxLength: 256
                        details:
                          description: Additional details about the link operation
                          additionalProperties: false
                          type: object
                          properties:
                            message_id:
                              description: Unique identifier of the email message
                              maxLength: 255
                              type: string
                          required:
                          - message_id
                      required:
                      - status
                      - code
                      - message
                      - details
                required:
                - Emails
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                description: Error response schema
                oneOf:
                - type: object
                  description: Details of errors for each email link operation
                  additionalProperties: false
                  properties:
                    Emails:
                      description: List of error details for each email link operation
                      maxItems: 20
                      type: array
                      items:
                        oneOf:
                        - type: array
                          description: Errors due to missing mandatory fields
                          maxItems: 20
                          items:
                            description: Details of a mandatory field missing error
                            additionalProperties: false
                            type: object
                            properties:
                              status:
                                description: Status of the error
                                type: string
                                enum:
                                - error
                              code:
                                description: Error code
                                type: string
                                enum:
                                - MANDATORY_NOT_FOUND
                              message:
                                description: Error message
                                maxLength: 256
                                type: string
                              details:
                                description: Additional details about the error
                                additionalProperties: false
                                type: object
                                properties:
                                  api_name:
                                    description: API name of the missing field
                                    maxLength: 255
                                    type: string
                                  json_path:
                                    description: JSON path to the missing field
                                    maxLength: 255
                                    type: string
                                required:
                                - api_name
                                - json_path
                            required:
                            - status
                            - code
                            - message
                            - details
                        - type: array
                          description: Errors due to invalid data
                          maxItems: 20
                          items:
                            description: Details of an invalid data error
                            additionalProperties: false
                            type: object
                            properties:
                              status:
                                description: Status of the error
                                type: string
                                enum:
                                - error
                              code:
                                description: Error code
                                type: string
                                enum:
                                - INVALID_DATA
                              message:
                                description: Error message
                                maxLength: 256
                                type: string
                              details:
                                description: Additional details about the error
                                additionalProperties: false
                                type: object
                                properties:
                                  api_name:
                                    description: API name of the field with invalid data
                                    maxLength: 255
                                    type: string
                                  json_path:
                                    description: JSON path to the field with invalid data
                                    maxLength: 255
                                    type: string
                                required:
                                - api_name
                                - json_path
                            required:
                            - status
                            - code
                            - message
                            - details
                  required:
                  - Emails
                - type: object
                  description: General error response for link emails to deals operation
                  additionalProperties: false
                  properties:
                    status:
                      description: Status of the error
                      type: string
                      enum:
                      - error
                    code:
                      description: Error code
                      type: string
                      enum:
                      - MANDATORY_NOT_FOUND
                    message:
                      description: Error message
                      maxLength: 256
                      type: string
                    details:
                      description: Additional details about the error
                      additionalProperties: false
                      type: object
                      properties:
                        api_name:
                          description: API name of the missing field
                          maxLength: 255
                          type: string
                        json_path:
                          maxLength: 255
                          description: JSON path to the missing field
                          type: string
                      required:
                      - api_name
                      - json_path
                  required:
                  - status
                  - code
                  - message
                  - details
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                description: Details of not found error
                additionalProperties: false
                type: object
                properties:
                  status:
                    description: Status of the error
                    type: string
                    enum:
                    - error
                  code:
                    description: Error code
                    type: string
                    enum:
                    - INVALID_URL_PATTERN
                  message:
                    description: Error message
                    type: string
                    enum:
                    - Please check if the URL trying to access is a correct one
                  details:
                    description: Additional details about the error
                    additionalProperties: false
                    type: object
                required:
                - status
                - code
                - message
                - details
      tags:
      - Contacts
    delete:
      security:
      - iam-oauth2-schema:
        - ZohoCRM.modules.contacts.CREATE
        - ZohoCRM.modules.emails.CREATE
        - ZohoCRM.modules.deals.CREATE
      summary: Unlink Emails from Records
      description: Unlinks the emails from the specified records in CRM.
      operationId: getRecordActions
      parameters:
      - $ref: '#/components/parameters/ContactId'
      - $ref: '#/components/parameters/MessageIds'
      - $ref: '#/components/parameters/OwnerId'
      responses:
        '200':
          description: success response
          content:
            application/json:
              schema:
                description: Response schema
                additionalProperties: false
                type: object
                properties:
                  Emails:
                    description: List of email unlink operation results
                    maxItems: 20
                    type: array
                    items:
                      description: Email unlink operation result
                      additionalProperties: false
                      type: object
                      properties:
                        status:
                          description: Status of the unlink operation
                          type: string
                          enum:
                          - success
                        code:
                          description: Result code of the unlink operation
                          type: string
                          enum:
                          - SUCCESS
                        message:
                          description: Detailed message about the unlink operation
                          maxLength: 256
                          type: string
                        details:
                          description: Additional details about the unlink operation
                          additionalProperties: false
                          type: object
                          properties:
                            message_id:
                              description: Unique identifier of the email message
                              maxLength: 256
                              type: string
                          required:
                          - message_id
                      required:
                      - status
                      - code
                      - message
                      - details
                required:
                - Emails
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                - description: Details of errors for each email unlink operation
                  additionalProperties: false
                  type: object
                  properties:
                    Emails:
                      description: ' Unique identifier of the module'
                      maxItems: 20
                      type: array
                      items:
                        oneOf:
                        - description: Errors due to missing mandatory fields
                          maxItems: 20
                          type: array
                          items:
                            description: ' Unique identifier of the module'
                            additionalProperties: false
                            type: object
                            properties:
                              status:
                                description: Status of the error
                                type: string
                                enum:
                                - error
                              code:
                                description: Error code
                                type: string
                                enum:
                                - MANDATORY_NOT_FOUND
                              message:
                                description: Error message
                                maxLength: 256
                                type: string
                              details:
                                description: ' Unique identifier of the module'
                                additionalProperties: false
                                type: object
                                properties:
                                  api_name:
                                    description: API name of the missing field
                                    maxLength: 255
                                    type: string
                                  json_path:
                                    description: JSON path to the missing field
                                    maxLength: 255
                                    type: string
                                required:
                                - api_name
                                - json_path
                            required:
                            - status
                            - code
                            - message
                            - details
                        - description: Errors due to invalid data
                          maxItems: 20
                          type: array
                          items:
                            description: ' Unique identifier of the module'
                            additionalProperties: false
                            type: object
                            properties:
                              status:
                                description: Status of the error
                                type: string
                                enum:
                                - error
                              code:
                                description: Error code
                                type: string
                                enum:
                                - INVALID_DATA
                              message:
                                description: Error message
                                maxLength: 256
                                type: string
                                enum:
                                - invalid data
                              details:
                                description: ' Unique identifier of the module'
                                additionalProperties: false
                                type: object
                                properties:
                                  api_name:
                                    description: API name of the field with invalid data
                                    maxLength: 255
                                    type: string
                                  json_path:
                                    description: JSON path to the field with invalid data
                                    maxLength: 255
                                    type: string
                                required:
                                - api_name
                                - json_path
                            required:
                            - status
                            - code
                            - message
                            - details
                  required:
                  - Emails
                - description: General error response for unlink emails from records operation
                  additionalProperties: false
                  type: object
                  properties:
                    status:
                      description: ' Unique identifier of the module'
                      type: string
                      enum:
                      - error
                    code:
                      description: ' Unique identifier of the module'
                      type: string
                      enum:
                      - MANDATORY_NOT_FOUND
                    message:
                      description: ' Unique identifier of the module'
                      maxLength: 256
                      type: string
                    details:
                      description: ' Unique identifier of the module'
                      additionalProperties: false
                      type: object
                      properties:
                        api_name:
                          description: ' Unique identifier of the module'
                          maxLength: 255
                          type: string
                        json_path:
                          description: ' Unique identifier of the module'
                          maxLength: 255
                          type: string
                      required:
                      - api_name
                      - json_path
                  required:
                  - status
                  - code
                  - message
                  - details
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                description: Details of not found error
                additionalProperties: false
                type: object
                oneOf:
                - additionalProperties: false
                  description: ' Unique identifier of the module'
                  type: object
                  properties:
                    status:
                      description: ' Unique identifier of the module'
                      type: string
                      enum:
                      - error
                    code:
                      description: ' Unique identifier of the module'
                      type: string
                      enum:
                      - INVALID_URL_PATTERN
                    message:
                      description: ' Unique identifier of the module'
                      type: string
                      enum:
                      - Please check if the URL trying to access is a correct one
                    details:
                      description: ' Unique identifier of the module'
                      additionalProperties: false
                      type: object
                  required:
                  - status
                  - code
                  - message
                  - details
                - description: General not found error response for unlink emails from records operation
                  additionalProperties: false
                  type: object
                  properties:
                    status:
                      description: ' Unique identifier of the module'
                      type: string
                      enum:
                      - error
                    code:
                      description: ' Unique identifier of the module'
                      type: string
                      enum:
                      - INVALID_URL_PATTERN
                    message:
                      description: ' Unique identifier of the module'
                      type: string
                      enum:
                      - Please check if the URL trying to access is a correct one
                    details:
                      description: ' Unique identifier of the module'
                      additionalProperties: false
                      type: object
                  required:
                  - status
                  - code
                  - message
                  - details
      tags:
      - Contacts
  /Contacts/{contactId}/Emails/{messageId}/actions/link_record:
    post:
      security:
      - iam-oauth2-schema:
        - ZohoCRM.modules.contacts.CREATE
        - ZohoCRM.modules.emails.CREATE
        - ZohoCRM.modules.deals.CREATE
      summary: Link Email to Record
      description: Links an email to a specified record in CRM.
      operationId: getRecordActionsSingle
      parameters:
      - $ref: '#/components/parameters/ContactId'
      - $ref: '#/components/parameters/MessageId'
      requestBody:
        content:
          application/json:
            schema:
              description: Request body schema for linking email to record
              additionalProperties: false
              type: object
              properties:
                Emails:
                  description: List of emails to be linked to records
                  maxItems: 1
                  type: array
                  items:
                    description: Details of an email to be linked to a record
                    additionalProperties: false
                    type: object
                    properties:
                      owner:
                        description: Owner of the email
                        additionalProperties: false
                        type: object
                        properties:
                          id:
                            description: Unique identifier of the owner
                            type: string
                            enum:
                            - '1238016000000362001'
                      linked_record:
                        description: Record to which the email is to be linked
                        additionalProperties: false
                        type: object
                        properties:
                          module:
                            description: Module of the record
                            additionalProperties: false
                            type: object
                            properties:
                              api_name:
                                type: string
                                description: API name of the module
                                enum:
                                - Deals
                              id:
                                type: string
                                description: Unique identifier of the module
                                enum:
                                - '1238016000000000131'
                            required:
                            - id
                          name:
                            description: Name of the record
                            type: string
                            enum:
                            - Sai Deal
                          id:
                            description: Unique identifier of the record
                            type: string
                            enum:
                            - '1238016000000514024'
                        required:
                        - module
                        - id
                    required:
                    - owner
                    - linked_record
        required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                description: Response schema for linking email to record
                additionalProperties: false
                type: object
                properties:
                  Emails:
                    maxItems: 1
                    description: List of email link operation results
                    type: array
                    items:
                      description: Email link operation result
                      additionalProperties: false
                      type: object
                      properties:
                        status:
                          description: Status of the link operation
                          type: string
                          enum:
                          - success
                        code:
                          description: Result code of the link operation
                          type: string
                          enum:
                          - SUCCESS
                        message:
                          description: Detailed message about the link operation
                          maxLength: 256
                          type: string
                        details:
                          additionalProperties: false
                          description: Additional details about the link operation
                          type: object
                          properties:
                            message_id:
                              description: Unique identifier of the email message
                              maxLength: 256
                              type: string
                          required:
                          - message_id
                      required:
                      - status
                      - code
                      - message
                      - details
                required:
                - Emails
        '400':
          description: Bad Request - Invalid input parameters
          content:
            application/json:
              schema:
                oneOf:
                - description: Details of errors for the email link operation
                  additionalProperties: false
                  type: object
                  properties:
                    Emails:
                      description: ' Unique identifier of the module'
                      maxItems: 1
                      type: array
                      items:
                        oneOf:
                        - description: Errors due to missing mandatory fields
                          maxItems: 1
                          type: array
                          items:
                            additionalProperties: false
                            description: ' Unique identifier of the module'
                            type: object
                            properties:
                              status:
                                description: Status of the error
                                type: string
                                enum:
                                - error
                              code:
                                description: Error code
                                type: string
                                enum:
                                - MANDATORY_NOT_FOUND
                              message:
                                description: ' Unique identifier of the message'
                                maxLength: 256
                                type: string
                              details:
                                description: ' Unique identifier of the module'
                                additionalProperties: false
                                type: object
                                properties:
                                  api_name:
                                    description: API name of the missing field
                                    maxLength: 255
                                    type: string
                                  json_path:
                                    description: JSON path to the missing field
                                    maxLength: 255
                                    type: string
                                required:
                                - api_name
                                - json_path
                            required:
                            - status
                            - code
                            - message
                            - details
                        - description: Errors due to

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