Zoho CRM Org API

openapi: 3.2.0
info:
  title: Zoho Crm Org API
  version: '8'
  description: 'Operations tagged Org across 3 of this provider''s published API definitions: zoho-crm-currencies-openapi.json, zoho-crm-org-openapi.json, zoho-crm-org-photo-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://zohoapis.{dc}/crm/{version}
  description: API Server
  variables:
    dc:
      description: API Server URL TLD
      default: com
      enum:
      - eu
      - com
      - au
      - in
      - jp
      - cn
      - ca
    version:
      description: API Version
      default: v8
tags:
- name: Org
paths:
  /org/currencies:
    get:
      summary: List currencies
      description: Retrieves all added currencies in the organization.
      operationId: getCurrencies
      responses:
        '200':
          description: Successfully retrieved currency data.
          content:
            application/json:
              schema:
                type: object
                description: Response object containing a list of currencies.
                properties:
                  currencies:
                    type: array
                    description: List of currencies configured for the organization.
                    maxItems: 180
                    items:
                      type: object
                      description: Currency object containing metadata and format details.
                      additionalProperties: false
                      properties:
                        prefix_symbol:
                          type: boolean
                          description: Indicates whether the currency symbol is shown before the amount.
                        format:
                          type: object
                          description: Currency formatting rules including numeral style, decimals and separators.
                          additionalProperties: false
                          required:
                          - numeral_system
                          - decimal_places
                          - decimal_separator
                          - thousand_separator
                          properties:
                            numeral_system:
                              type: string
                              enum:
                              - Indian
                              - International
                              default: International
                              description: 'Number formatting style: Indian (1,00,000) vs International (100,000).'
                            decimal_places:
                              type: string
                              enum:
                              - '0'
                              - '2'
                              - '3'
                              - '4'
                              - '5'
                              - '6'
                              description: Number of decimal digits displayed for the currency.
                            decimal_separator:
                              type: string
                              enum:
                              - Comma
                              - Period
                              description: Symbol used to separate the fractional decimal part.
                            thousand_separator:
                              type: string
                              enum:
                              - Comma
                              - Period
                              - Space
                              description: Symbol used to group thousands in numeric values.
                        exchange_rate:
                          type: string
                          pattern: ^[0-9]{1,9}(\.[0-9]{1,9})?$
                          maxLength: 18
                          description: Exchange rate relative to the base currency (supports up to 9 digits and 9 decimal places).
                        is_active:
                          type: boolean
                          description: Indicates whether the currency is active and available for use.
                        exchange_rate_auto_update:
                          type: boolean
                          description: Indicates whether the currency has the automated exchange rate option enabled or not.
                        iso_code:
                          type: string
                          maxLength: 255
                          description: 'ISO standard currency code. Example: INR, USD.'
                        symbol:
                          type: string
                          maxLength: 255
                          description: Symbol used to represent the currency.
                        name:
                          type: string
                          maxLength: 255
                          description: 'Name of the currency. Example: Indian Rupee.'
                        is_base:
                          type: boolean
                          description: Indicates whether this currency is the organization's base currency.
                        id:
                          type: string
                          maxLength: 255
                          description: Unique identifier of the currency.
                        created_by:
                          type: object
                          description: User who created the currency record.
                          additionalProperties: false
                          required:
                          - name
                          - id
                          properties:
                            name:
                              type: string
                              maxLength: 255
                              description: Name of the user who created the record.
                            id:
                              type: string
                              maxLength: 255
                              description: User ID of the record creator.
                        modified_by:
                          type: object
                          description: User who last updated the currency record.
                          additionalProperties: false
                          required:
                          - name
                          - id
                          properties:
                            name:
                              type: string
                              maxLength: 255
                              description: Name of the user who modified the record.
                            id:
                              type: string
                              maxLength: 255
                              description: User ID of the last modifier.
                        modified_time:
                          type: string
                          format: date-time
                          description: Timestamp when the currency was last modified.
                        created_time:
                          type: string
                          format: date-time
                          description: Timestamp when the currency was first created.
                        exchange_rate_updated_time:
                          type: string
                          format: date-time
                          description: Timestamp when the exchange rate was last modified.
                      required:
                      - prefix_symbol
                      - format
                      - exchange_rate
                      - is_active
                      - iso_code
                      - symbol
                      - name
                      - is_base
                      - id
                      - created_by
                      - modified_by
                      - modified_time
                      - created_time
                required:
                - currencies
                additionalProperties: false
        '204':
          description: No content — occurs if no currencies are available.
      security:
      - iam-oauth2-schema:
        - ZohoCRM.settings.currencies.READ
      tags:
      - Org
    post:
      summary: Create currencies
      description: Creates one or more new currencies for the organization.
      operationId: createCurrencies
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: Request object containing a list of currencies to create.
              properties:
                currencies:
                  type: array
                  maxItems: 180
                  description: List of currencies to be added.
                  items:
                    type: object
                    description: Currency definition object.
                    additionalProperties: false
                    properties:
                      format:
                        type: object
                        description: Formatting rules for numbers displayed in this currency.
                        additionalProperties: false
                        properties:
                          numeral_system:
                            type: string
                            enum:
                            - Indian
                            - International
                            default: International
                            description: Numbering system used for grouping digits.
                          decimal_places:
                            type: string
                            enum:
                            - '0'
                            - '2'
                            - '3'
                            - '4'
                            - '5'
                            - '6'
                            description: Number of decimal places used for the currency.
                          decimal_separator:
                            type: string
                            enum:
                            - Comma
                            - Period
                            description: Character used to separate whole number and fractional part.
                          thousand_separator:
                            type: string
                            enum:
                            - Comma
                            - Period
                            - Space
                            description: Character used for separating thousand groups.
                      exchange_rate:
                        type: string
                        pattern: ^[0-9]{1,9}(\.[0-9]{1,9})?$
                        maxLength: 18
                        description: Conversion rate relative to the base currency. Supports up to 9 digits and 9 decimal places.
                      is_active:
                        type: boolean
                        description: Indicates whether the currency is active.
                      exchange_rate_auto_update:
                        type: boolean
                        description: Indicates whether the currency has the automated exchange rate option enabled or not.
                      iso_code:
                        type: string
                        maxLength: 3
                        description: Standard ISO currency code. Must be unique.
                      symbol:
                        type: string
                        maxLength: 50
                        description: Currency symbol used for display.
                      name:
                        type: string
                        maxLength: 255
                        description: Full currency name as configured in CRM.
                    required:
                    - exchange_rate
                    - iso_code
              required:
              - currencies
              additionalProperties: false
      responses:
        '200':
          description: Currencies successfully created.
          content:
            application/json:
              schema:
                type: object
                description: Successful creation response wrapper.
                additionalProperties: false
                properties:
                  currencies:
                    type: array
                    description: List of successfully created currency responses.
                    maxItems: 100
                    items:
                      description: successfully created currency responses
                      type: object
                      additionalProperties: false
                      properties:
                        code:
                          type: string
                          enum:
                          - SUCCESS
                          description: Indicates success.
                        message:
                          type: string
                          maxLength: 255
                          description: Human-readable success message.
                        details:
                          type: object
                          description: Contains currency identifier.
                          additionalProperties: false
                          properties:
                            id:
                              type: string
                              maxLength: 50
                              description: Unique currency identifier.
                          required:
                          - id
                        status:
                          type: string
                          enum:
                          - success
                          description: Operation result indicator.
                      required:
                      - code
                      - message
                      - details
                      - status
                required:
                - currencies
        '400':
          description: Bad request. The input data is invalid or missing required values.
          content:
            application/json:
              schema:
                description: Possible error responses for currency creation operation.
                oneOf:
                - type: object
                  description: Single permission-level error response.
                  additionalProperties: false
                  required:
                  - code
                  - message
                  - status
                  - details
                  properties:
                    code:
                      type: string
                      description: Error code indicating type of error.
                      enum:
                      - NO_PERMISSION
                      maxLength: 100
                    message:
                      type: string
                      description: Human-readable explanation of the error.
                      maxLength: 255
                    details:
                      type: object
                      description: Extra information related to permission error.
                      additionalProperties: false
                      properties:
                        permissions:
                          type: array
                          maxItems: 100
                          items:
                            type: string
                            description: Needed permission details
                            maxLength: 255
                          description: List of required permissions that were missing.
                    status:
                      type: string
                      description: Response status indicator.
                      enum:
                      - error
                      maxLength: 20
                - type: object
                  description: Currency validation errors for bulk operations.
                  additionalProperties: false
                  required:
                  - currencies
                  properties:
                    currencies:
                      type: array
                      description: List of currency errors for bulk operations.
                      maxItems: 100
                      items:
                        type: object
                        description: Error response with validation details for a single currency record.
                        additionalProperties: false
                        required:
                        - code
                        - message
                        - status
                        - details
                        properties:
                          code:
                            type: string
                            description: Error code indicating type of error.
                            maxLength: 100
                          message:
                            type: string
                            description: Human-readable explanation of the error.
                            maxLength: 255
                          details:
                            type: object
                            description: Extra information related to validation error.
                            additionalProperties: true
                            properties:
                              api_name:
                                type: string
                                maxLength: 255
                                description: Name of the parameter causing validation error.
                              json_path:
                                type: string
                                maxLength: 255
                                description: JSON pointer to the invalid property location.
                              expected_data_type:
                                type: string
                                maxLength: 50
                                description: Required datatype for the field when applicable.
                              limit:
                                type: number
                                description: Limit count reference for maximum allowed active currencies.
                          status:
                            type: string
                            enum:
                            - error
                            description: Response status indicator.
                            maxLength: 20
      security:
      - iam-oauth2-schema:
        - ZohoCRM.settings.currencies.CREATE
      tags:
      - Org
    put:
      summary: Update currencies
      description: Updates one or more currencies other than the base currency.
      operationId: updateCurrencies
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: Request body to update currency values in the organization.
              properties:
                currencies:
                  type: array
                  description: List of currencies to be updated.
                  maxItems: 100
                  items:
                    type: object
                    description: Currency update request object.
                    additionalProperties: false
                    properties:
                      id:
                        type: string
                        maxLength: 255
                        description: Unique ID of the currency to update. Obtainable from GET /org/currencies.
                      format:
                        type: object
                        description: Currency formatting properties.
                        additionalProperties: false
                        properties:
                          numeral_system:
                            type: string
                            enum:
                            - Indian
                            - International
                            default: International
                            description: Specifies whether the currency uses the Indian numbering format (1,00,000) or International format (100,000).
                          decimal_places:
                            type: string
                            enum:
                            - '0'
                            - '2'
                            - '3'
                            - '4'
                            - '5'
                            - '6'
                            description: Number of decimal places allowed for currency values.
                          decimal_separator:
                            type: string
                            enum:
                            - Comma
                            - Period
                            description: Character used to separate the integer portion from the fractional portion.
                          thousand_separator:
                            type: string
                            maxLength: 255
                            enum:
                            - Comma
                            - Period
                            - Space
                            description: Character used to group thousands in the currency format.
                      exchange_rate:
                        type: string
                        pattern: ^[0-9]{1,9}(\.[0-9]{1,9})?$
                        maxLength: 18
                        description: Conversion rate of this currency relative to the base currency.
                      is_active:
                        type: boolean
                        description: Indicates whether the currency is active in the organization.
                      exchange_rate_auto_update:
                        type: boolean
                        description: Indicates whether the currency has the automated exchange rate option enabled or not.
                      iso_code:
                        type: string
                        maxLength: 255
                        description: 'ISO code of the currency. NOTE: During update, ISO code cannot be modified.'
                      symbol:
                        type: string
                        maxLength: 50
                        description: Symbol used to display the currency
                      name:
                        type: string
                        maxLength: 255
                        description: 'Name of the currency. NOTE: During update, currency name cannot be modified.'
                    required:
                    - id
              required:
              - currencies
              additionalProperties: false
      responses:
        '200':
          description: Successfully updated the currency properties.
          content:
            application/json:
              schema:
                type: object
                description: Response returned for a successful update operation.
                additionalProperties: false
                required:
                - currencies
                properties:
                  currencies:
                    type: array
                    description: List of updated currency responses.
                    maxItems: 100
                    items:
                      type: object
                      description: Currency update result object.
                      additionalProperties: false
                      properties:
                        code:
                          type: string
                          description: Response code
                          maxLength: 50
                        message:
                          type: string
                          description: Response message
                          maxLength: 255
                        details:
                          type: object
                          description: Additional response details
                          properties:
                            id:
                              type: string
                              description: Currency ID
                              maxLength: 50
                          required:
                          - id
                          additionalProperties: false
                        status:
                          type: string
                          description: Status of the operation
                          enum:
                          - success
                      required:
                      - code
                      - message
                      - details
                      - status
        '400':
          description: Bad request. Input validation errors or disallowed update field.
          content:
            application/json:
              schema:
                description: Possible error responses for currency update operation.
                oneOf:
                - type: object
                  description: Permission-level or single validation error.
                  additionalProperties: false
                  required:
                  - code
                  - message
                  - status
                  - details
                  properties:
                    code:
                      type: string
                      description: Error identifier representing the failure type.
                      enum:
                      - NO_PERMISSION
                      maxLength: 100
                    message:
                      type: string
                      description: Human-readable message describing the error.
                      maxLength: 255
                    details:
                      type: object
                      description: Additional information about the error.
                      additionalProperties: false
                      properties:
                        permissions:
                          type: array
                          description: List of required permissions missing for the current user.
                          maxItems: 100
                          items:
                            type: string
                            description: Needed permission details
                            maxLength: 100
                    status:
                      type: string
                      description: Indicates that the response represents an error condition.
                      enum:
                      - error
                      maxLength: 20
                - type: object
                  description: Currency validation errors.
                  additionalProperties: false
                  required:
                  - currencies
                  properties:
                    currencies:
                      type: array
                      description: Array of currency error objects representing individual validation or permission errors.
                      maxItems: 100
                      items:
                        type: object
                        description: An object representing a single currency-related error.
                        additionalProperties: false
                        required:
                        - code
                        - message
                        - details
                        - status
                        properties:
                          code:
                            type: string
                            description: Error identifier representing the validation failure type.
                            enum:
                            - INVALID_DATA
                            - ACTIVE_STATE_LIMIT_EXCEEDED
                            - NOT_ALLOWED
                            maxLength: 100
                          message:
                            type: string
                            description: Human-readable message describing the error.
                            maxLength: 255
                          details:
                            type: object
                            description: Additional debugging metadata for the error. Provides field-level or permission-level details.
                            additionalProperties: false
                            properties:
                              api_name:
                                type: string
                                description: The field name, API parameter, or array index related to the error.
                                maxLength: 255
                              json_path:
                                type: string
                                description: JSON path pointing to the field that caused the error.
                                maxLength: 255
                              limit:
                                type: integer
                                description: Maximum allowed limit relevant to the error, e.g., max active currencies.
                                format: int32
                              expected_data_type:
                                type: string
                                description: Expected data type for the invalid field.
                                maxLength: 50
                              maximum_decimal_place:
                                type: number
                                description: Maximum allowed decimal places for currency values.
                                format: int32
                          status:
                            type: string
                            description: Indicates that the response represents an error condition.
                            enum:
                            - error
      security:
      - iam-oauth2-schema:
        - ZohoCRM.settings.currencies.UPDATE
      tags:
      - Org
    servers:
    - url: https://zohoapis.{dc}/crm/{version}
      description: API Server
      variables:
        dc:
          description: API Server URL TLD
          default: com
          enum:
          - eu
          - com
          - au
          - in
          - jp
          - cn
          - ca
        version:
          description: API Version
          default: v8
  /org/currencies/{currency}:
    get:
      summary: Get currency by ID
      description: Retrieves details of a specific currency via its unique currency ID.
      operationId: getCurrencyById
      parameters:
      - $ref: '#/components/parameters/Currency'
        description: Unique identifier of the currency to retrieve.
      responses:
        '200':
          description: Successfully retrieved the currency details.
          content:
            application/json:
              schema:
                type: object
                description: Currency response object.
                properties:
                  currencies:
                    type: array
                    description: Array containing the requested currency object.
                    maxItems: 1
                    items:
                      type: object
                      description: Currency object with formatting, exchange info and settings.
                      additionalProperties: false
                      properties:
                        prefix_symbol:
                          type: boolean
                          description: If true, the currency symbol appears before the numerical value.
                        format:
                          type: object
                          description: Defines how the currency value is displayed including separators and numeral system.
                          additionalProperties: false
                          required:
                          - numeral_system
                          - decimal_places
                          - decimal_separator
                          - thousand_separator
                          properties:
                            numeral_system:
                              type: string
                              enum:
                              - Indian
                              - International
                              default: International
                              description: Numeral grouping system used for formatting.
                            decimal_places:
                              type: string
                              enum:
                              - '0'
                              - '2'
                              - '3'
                              - '4'
                              - '5'
                              - '6'
                              description: Number of digits shown after decimal point.
                        

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