openapi: 3.1.0 info: title: Helpcenter Org API version: 1.0.0 tags: - name: Org paths: /org/photo: get: security: - iam-oauth2-schema: - ZohoCRM.org.READ summary: Get Org Photo description: Retrieve the organization photo operationId: getOrgPhoto responses: '200': description: Successfully retrieved the organization photo content: image/png: schema: type: string format: binary description: Binary image data representing the organization photo in PNG format '204': description: No content - organization photo not found tags: - Org post: security: - iam-oauth2-schema: - ZohoCRM.org.CREATE summary: Upload Organization Photo description: Upload a photo for the organization operationId: uploadOrganizationPhoto requestBody: content: multipart/form-data: schema: type: object description: Request body for uploading organization photo additionalProperties: false properties: file: type: object description: The image file to upload as organization photo additionalProperties: false required: - file required: true responses: '200': description: Successfully uploaded the organization photo content: application/json: schema: oneOf: - type: object description: Success response for organization photo upload additionalProperties: false properties: status: type: string description: Status of the operation enum: - success code: type: string description: Response code enum: - SUCCESS message: type: string description: Success message maxLength: 1000 details: type: object description: Additional details about the operation additionalProperties: false properties: {} '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: type: object description: Error response for bad request additionalProperties: false properties: status: type: string description: Status of the operation enum: - error code: type: string description: Error code indicating the type of error enum: - INVALID_URL_PATTERN - INVALID_DATA - INVALID_REQUEST_METHOD - INVALID_REQUEST - INVALID_TOKEN message: type: string description: Error message describing the issue maxLength: 1000 details: type: object description: Additional details about the error additionalProperties: false properties: {} '403': description: Forbidden - insufficient permissions to upload organization photo content: application/json: schema: type: object description: Error response for forbidden access additionalProperties: false properties: status: type: string description: Status of the operation enum: - error code: type: string description: Error code indicating no permission enum: - NO_PERMISSION message: type: string description: Error message describing the permission issue maxLength: 1000 details: type: object description: Additional details about the permission error additionalProperties: false properties: items: type: string description: Permission items that are missing maxLength: 500 '413': description: Payload Too Large - file size exceeds the maximum allowed limit content: application/json: schema: type: object description: Error response for file size exceeds limit additionalProperties: false properties: status: type: string description: Status of the operation enum: - error code: type: string description: Error code indicating file size exceeds limit enum: - FILE_SIZE_EXCEEDS message: type: string description: Error message describing the file size issue maxLength: 1000 details: type: object description: Additional details about the file size error additionalProperties: false properties: size: type: integer description: Maximum allowed file size in bytes format: int32 '415': description: Unsupported Media Type - invalid file format or resolution exceeds limit content: application/json: schema: oneOf: - type: object description: Error response for file resolution exceeds limit additionalProperties: false properties: status: type: string description: Status of the operation enum: - error code: type: string description: Error code indicating file resolution exceeds limit enum: - FILE_RESOLUTION_EXCEEDS message: type: string description: Error message describing the resolution issue maxLength: 1000 details: type: object description: Additional details about the resolution error additionalProperties: false properties: resolution: type: integer description: Maximum allowed resolution in pixels format: int32 - type: object description: Error response for invalid file format additionalProperties: false properties: status: type: string description: Status of the operation enum: - error code: type: string description: Error code indicating invalid data enum: - INVALID_DATA message: type: string description: Error message describing the invalid file format maxLength: 1000 details: type: object description: Additional details about the error additionalProperties: false required: - status - code - message - details tags: - Org delete: security: - iam-oauth2-schema: - ZohoCRM.org.DELETE summary: Delete Organization Photo description: Delete the organization photo operationId: delete responses: '200': description: Successfully deleted the organization photo content: application/json: schema: oneOf: - type: object description: Success response for organization photo deletion additionalProperties: false properties: status: type: string description: Status of the operation enum: - success code: type: string description: Response code enum: - SUCCESS message: type: string description: Success message maxLength: 1000 details: type: object description: Additional details about the operation additionalProperties: false '400': description: Bad Request - Invalid request parameters or data content: application/json: schema: type: object description: Error response for bad request additionalProperties: false properties: status: type: string description: Status of the operation enum: - error code: type: string description: Error code indicating the type of error enum: - INVALID_URL_PATTERN - INVALID_DATA - INVALID_REQUEST_METHOD - INVALID_REQUEST - INVALID_TOKEN message: type: string description: Error message describing the issue maxLength: 1000 details: type: object description: Additional details about the error additionalProperties: false '403': description: Forbidden - insufficient permissions to delete organization photo content: application/json: schema: type: object description: Error response for forbidden access additionalProperties: false properties: status: type: string description: Status of the operation enum: - error code: type: string description: Error code indicating no permission enum: - NO_PERMISSION message: type: string description: Error message describing the permission issue maxLength: 1000 details: type: object description: Additional details about the permission error additionalProperties: false properties: permissions: type: array description: List of required permissions maxItems: 100 items: type: string description: Permission name maxLength: 500 tags: - Org /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 /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. decimal_separator: type: string enum: - Comma - Period description: Character used as decimal separator. thousand_separator: type: string enum: - Comma - Period - Space description: Character used for grouping thousand digits. exchange_rate: type: string pattern: ^[0-9]{1,9}(\.[0-9]{1,9})?$ maxLength: 18 description: Exchange rate relative to the base currency. is_active: type: boolean description: Indicates whether the currency is currently 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: Official ISO currency code. symbol: type: string maxLength: 50 description: Symbol representing the currency. name: type: string maxLength: 255 description: Full currency name. is_base: type: boolean description: Indicates whether this is the base currency of the organization. id: type: string maxLength: 255 description: Unique ID associated with this 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 this currency. id: type: string maxLength: 255 description: User ID of the creator. modified_by: type: object description: User who last modified the currency record. additionalProperties: false required: - name - id properties: name: type: string maxLength: 255 description: Name of the user who last updated this currency. 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 initially 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 — currency not found or nothing to return. security: - iam-oauth2-schema: - ZohoCRM.settings.currencies.READ tags: - Org put: summary: Update currency by ID description: Update a specific currency by its unique ID. operationId: updateCurrencyById parameters: - $ref: '#/components/parameters/Currency' requestBody: required: true content: application/json: schema: type: object description: Payload for updating a specific currency by ID. properties: currencies: type: array description: List of currencies to update (single-element array expected). maxItems: 100 items: type: object description: Currency object containing update fields. additionalProperties: false properties: format: type: object description: Configuration for currency formatting rules. additionalProperties: false properties: numeral_system: type: string enum: - Indian - International default: International description: Defines the numbering system used for digit grouping. decimal_places: type: string enum: - '0' - '2' - '3' - '4' - '5' - '6' description: Specifies number of fractional digits allowed in currency format. decimal_separator: type: string enum: - Comma - Period description: Character used to separate whole numbers and fractional part. thousand_separator: type: string enum: - Comma - Period - Space description: Character used to separate thousands for currency display. exchange_rate: type: string pattern: ^[0-9]{1,9}(\.[0-9]{1,9})?$ maxLength: 18 description: Rate at which this currency exchanges with the base currency. 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. required: - currencies additionalProperties: false responses: '200': description: Successfully updated the specified currency record(s). content: application/json: schema: type: object description: Response object containing updated currency data. additionalProperties: false required: - currencies properties: currencies: type: array description: List of updated currency responses. maxItems: 100 items: type: object description: Individual currency update response properties: code: type: string description: Response code maxLength: 255 message: type: string description: Response message maxLength: 255 details: type: object description: Detailed information about the currency update properties: id: type: string description: Unique currency ID maxLength: 50 required: - id additionalProperties: true status: type: string description: Status of the response enum: - success required: - code - message - details - status additionalProperties: false '400': description: Bad request. The input contains malformed or invalid values. 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 - INVALID_DATA maxLength: 100 message: type: string description: Human-readable message describing the error. maxLength: 255 details: type: object description: Additional information about the error. additionalProperties: true 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: true 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 status: type: string description: Indicates that the response represents an error condition. enum: - error maxLength: 20 security: - iam-oauth2-schema: - ZohoCRM.settings.currencies.UPDATE tags: - Org /org/currencies/actions/enable: post: summary: Enable multi-currency description: Enable multi-currency for the organization and set the base currency. operationId: enableCurrency requestBody: required: true content: application/json: schema: type: object description: Payload for creating and enabling base currency. properties: base_currency: type: object description: Base currency details for initialization. properties: prefix_symbol: type: boolean description: If true, currency symbol is shown before value. iso_code: type: string maxLength: 255 description: ISO currency code (e.g., USD, INR, EUR). symbol: type: string maxLength: 255 description: Currency symbol to display. exchange_rate: type: string pattern: ^[0-9]{1,9}(\.[0-9]{1,9})?$ maxLength: 50 description: Value of currency relative to base currency. format: type: object description: Currency formatting configuration. properties: numeral_system: type: string enum: - Indian - International default: International description: Indicates whether the currency should use the Indian or International numbering format. decimal_places: type: string enum: - '0' - '2' - '3' - '4' - '5' - '6' description: Number of decimal places to display for the currency value. decimal_separator: type: string enum: - Comma - Period description: Character used to separate whole numbers from fractional decimal values. thousand_separator: type: string enum: - Comma - Period - Space description: Character used to group thousands in numeric values. additionalProperties: false name: type: string maxLength: 255 description: Full name of the currency (e.g., US Dollar - USD). required: - iso_code - exchange_rate additionalProperties: false required: - base_currency additionalProperties: false responses: '200': description: Successfully enabled and created base currency. content: application/json: schema: type: object description: Successful enable response properties: base_currency: type: object description: Success response object. properties: code: type: string maxLength: 50 description: Result code, e.g., SUCCESS. details: type: object properties: id: type: string maxLength: 255 description: ID of the created base currency. additionalProperties: false description: Additional response details. message: type: string maxLength: 255 description: Human-readable success message. status: type: string maxLength: 50 description: Operation status, e.g., success. required: - code - details - message - status additionalProperties: false required: - base_currency additionalProperties: false '400': description: Invalid request or validation errors. content: application/json: schema: type: object description: Error response for multi-currency enablement. Can contain general errors or base_currency-specific errors. additionalProperties: false properties: code: type: string description: Error identifier representing the failure type. enum: - NO_PERMISSION - ALREADY_ENABLED - INVALID_DATA - MANDATORY_NOT_FOUND - NOT_ALLOWED maxLength: 100 message: type: string description: Human-readable error message. maxLength: 255 status: type: string description: Indicates error status. enum: - error maxLength: 20 details: type: object description: Optional metadata for general errors (permissions etc.). additionalProperties: false properties: permissions: type: array description: List of missing permissions. items: description: Needed permission details type: string maxLength: 100 maxItems: 100 base_currency: type: object description: Optional base_currency error object for currency-specific errors. additionalProperties: false properties: code: type: string enum: - ALREADY_ENABLED - INVALID_DATA - MANDATORY_NOT_FOUND - NOT_ALLOWED description: Error code for base_currency validation. maxLength: 100 message: type: string description: Human-readable base_currency error message. maxLength: 255 status: type: string enum: - error description: Status for the base_currency error. maxLength: 20 details: type: object description: Additional details for base_currency error (field name, JSON path). additionalProperties: true properties: api_name: type: string description: Field or API parameter related to the error. maxLength: 255 json_path: type: string description: JSON path pointing to the error field. maxLength: 255 required: [] security: - iam-oauth2-schema: - ZohoCRM.settings.currencies.CREATE tags: - Org put: summary: Update base currency description: Update existing base currency details. operationId: updateBaseCurrency requestBody: required: true content: application/json: schema: type: object description: Payload for modifying existing base currency. properties: base_currency: type: object description: Updated base currency values. properties: iso_code: type: string maxLength: 255 description: ISO currency code. symbol: type: string maxLength: 255 description: Currency symbol. exchange_rate: type: string pattern: ^[0-9]{1,9}(\.[0-9]{1,9})?$ maxLength: 50 description: Updated exchange rate. It should be one format: type: object description: Currency display formatting. 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. decimal_separator: type: string enum: - Comma - Period description: Decimal separator character. thousand_separator: type: string maxLength: 255 enum: - Comma - Period - Space description: Thousand separator character. additionalProperties: false name: type: string maxLength: 255 description: Currency display name. id: type: string maxLength: 255 description: Unique identifier of the currency. required: - id additionalProperties: false required: - base_currency additionalProperties: false responses: '200': description: Currency updated successfully. content: application/json: schema: type: object description: Successful update response properties: base_currency: type: object description: Result of base currency update properties: code: type: string maxLength: 50 description: Result code. message: type: string maxLength: 255 description: Human readable message. status: type: string maxLength: 50 description: Operation status. details: type: object properties: id: type: string maxLength: 255 description: ID of the created base currency. additionalProperties: false description: Additional response details. required: - code - message - status - details additionalProperties: false required: - base_currency additionalProperties: false '400': description: Invalid request or validation errors. content: application/json: schema: type: object description: Error response for multi-currency enablement. Can contain general errors or base_currency-specific errors. additionalProperties: false properties: code: type: string description: Error identifier representing the failure type. enum: - NO_PERMISSION - ALREADY_ENABLED - INVALID_DATA - MANDATORY_NOT_FOUND - NOT_ALLOWED maxLength: 100 message: type: string description: Human-readable error message. maxLength: 255 status: type: string description: Indicates error status. enum: - error maxLength: 20 details: type: object description: Optional metadata for general errors (permissions etc.). additionalProperties: false properties: permissions: type: array description: List of missing permissions. items: description: Needed permission details type: string maxLength: 100 maxItems: 100 base_currency: type: object description: Optional base_currency error object for currency-specific errors. additionalProperties: false properties: code: type: string enum: - ALREADY_ENABLED - INVALID_DATA - MANDATORY_NOT_FOUND - NOT_ALLOWED description: Error code for base_currency validation. maxLength: 100 message: type: string description: Human-readable base_currency error message. maxLength: 255 status: type: string enum: - error description: Status for the base_currency error. maxLength: 20 details: type: object description: Additional details for base_currency error (field name, JSON path). additionalProperties: false properties: api_name: type: string description: Field or API parameter related to the error. maxLength: 255 json_path: type: string description: JSON path pointing to the error field. maxLength: 255 required: [] security: - iam-oauth2-schema: - ZohoCRM.settings.currencies.UPDATE tags: - Org /org: get: operationId: getOrganization summary: Get Organization data description: To get the Company Details security: - iam-oauth2-schema: - ZohoCRM.org.READ responses: '200': description: Returns an array of organization details. content: application/json: schema: type: object description: JSON Response properties: org: description: array of organization details type: array maxItems: 1 items: $ref: '#/components/schemas/OrgDetails' additionalProperties: false required: - org tags: - Org components: parameters: Currency: name: currency in: path required: true description: Path parameter identifying the currency ID. schema: type: string maxLength: 255 schemas: OrgDetails: type: object description: Company details properties: country: oneOf: - type: string maxLength: 50 description: value present - type: 'null' description: null value description: Company's country photo_id: readOnly: true oneOf: - type: string description: photo present maxLength: 50 - type: 'null' description: null value description: photo id of the company's logo city: oneOf: - type: string maxLength: 50 description: value present - type: 'null' description: null value description: Company's city description: oneOf: - type: string maxLength: 250 description: value present - type: 'null' description: null value description: description type: type: string enum: - bigin - production - sandbox - developer description: type of org readOnly: true created_time: type: string format: date-time description: time of creation readOnly: true mc_status: type: - boolean - 'null' description: multi currency status readOnly: true gapps_enabled: type: boolean description: google apps integration status readOnly: true translation_enabled: type: boolean description: translation status readOnly: true street: oneOf: - type: string maxLength: 50 description: value present - type: 'null' description: null value description: Company's street domain_name: type: string pattern: '[a-z][a-z0-9]{4,30}' maxLength: 30 description: domain name of the organization alias: oneOf: - type: string maxLength: 50 description: value present - type: 'null' description: null value description: Company's alias currency: type: string description: home currency maxLength: 30 id: type: string description: org id maxLength: 20 readOnly: true employee_count: oneOf: - type: string maxLength: 18 pattern: '[0-9]+' description: value present - type: 'null' description: null value description: Company's employee count state: oneOf: - type: string maxLength: 50 description: state - type: 'null' description: null value description: Company's state fax: oneOf: - type: string maxLength: 30 description: value present - type: 'null' description: null value description: Company's fax zip: oneOf: - type: string maxLength: 20 description: value present - type: 'null' description: null value description: Company's postal code website: oneOf: - type: string maxLength: 50 pattern: ^(http:\/\/www.|https:\/\/www.|ftp:\/\/www.|www.|http:\/\/|https:\/\/|ftp:\/\/|){1}[^\x00-\x19\x22-\x27\x2A-\x2C\x2E-\x2F\x3A-\x3F\x5B-\x5E\x60\x7B\x7D-\x7F]+(\.[^\x00-\x19\x22\x24-\x2C\x2E-\x2F\x3C\x3E\x40\x5B-\x5E\x60\x7B\x7D-\x7F]+)+([\/\?].*)*$ description: value present - type: 'null' description: null value description: Company's website currency_symbol: type: string maxLength: 5 minLength: 1 description: home currency symbol mobile: oneOf: - type: string maxLength: 30 pattern: ^[+]?([0-9A-Za-z()\.\-\s]){1,30}$ description: value present - type: 'null' description: null value description: Company's mobile currency_locale: type: string maxLength: 10 description: home currency locale primary_zuid: oneOf: - type: string maxLength: 20 description: zuid of the super admin - type: 'null' description: null value if there is no super admin(only when company details not updated) readOnly: true zia_portal_id: type: - string - 'null' description: zia portal id readOnly: true time_zone: type: string maxLength: 30 description: Company's time zone zgid: type: string description: zgid maxLength: 20 readOnly: true country_code: type: - string - 'null' description: Company's country code deletable_org_account: type: boolean description: is deletable readOnly: true license_details: type: object readOnly: true description: license details properties: paid_expiry: oneOf: - type: string format: date-time description: value present - type: 'null' description: null value readOnly: true description: license expiry date users_license_purchased: type: integer format: int32 readOnly: true description: no of users can be added based on the purchased licenses trial_type: type: - string - 'null' description: trial type readOnly: true trial_expiry: type: - string - 'null' description: trial expiry date paid: type: boolean description: is paid edition account readOnly: true paid_type: type: string readOnly: true description: actual license type enum: - free - standard - professional - enterprise - ultimate - crmplus - crmplusstarter - zohooneenterprise - zohoonestandard portal_users_license_purchased: type: integer format: int32 description: no of portal users can be added based on the purchased licenses readOnly: true additionalProperties: false required: - users_license_purchased - paid - paid_type - portal_users_license_purchased hierarchy_preferences: type: object properties: type: type: string enum: - Role_Hierarchy - Reporting_To_Hierarchy description: type of hierarchy strictly_reporting: type: - boolean - 'null' description: non reporting users data should be visible to CEO and Administator(true) or any user higher in the hierarchy(false) required: - type additionalProperties: false description: hierarchy preference of an organization phone: oneOf: - type: string maxLength: 30 pattern: ^[+]?([0-9A-Za-z()\.\-\s]){1,30}$ description: phone number present - type: 'null' description: null value description: Company's phone number company_name: oneOf: - type: string maxLength: 100 description: Company name present - type: 'null' description: null value. readOnly: true description: Company's name privacy_settings: type: boolean description: privacy settings enabled status readOnly: true primary_email: oneOf: - type: string pattern: ^[\+\-\p{L}\p{M}\p{N}_]([\p{L}\p{M}\p{N}!#$%&'*+\-\/=?^_`{|}~.]*)@(?=.{4,256}$)(([\p{L}\p{N}\p{M}]+)(([\-_]*[\p{L}\p{M}\p{N}])*)[.])+[\p{L}\p{M}]{2,22}$ description: super admin present maxLength: 100 - type: 'null' description: null value if there is no super admin(only when company details not updated) description: Email of the super admin iso_code: type: string maxLength: 10 description: iso code of the home currency hipaa_compliance_enabled: type: boolean description: hipaa compliances enabled status readOnly: true lite_users_enabled: type: boolean description: lite users enabled status readOnly: true additionalProperties: false securitySchemes: iam-oauth2-schema: $ref: ./Common.json#/components/securitySchemes/iam-oauth2-schema x-entity: Helpcenter