Update Currencies

Purpose

To update currency details.

Endpoints

Request Details

Request URL

To update home currency:
{api-domain}/crm/{version}/org/currencies/actions/enable

To update currencies other than home currency:
{api-domain}/crm/{version}/org/currencies

To update a specific currency:
{api-domain}/crm/{version}/org/currencies/{currency_ID}

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

scope=ZohoCRM.settings.currencies.{operation_type}

Possible operation types

UPDATE - Update currencies data

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v5/org/currencies/actions/enable"
-X PUT
-d input.json
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

In the request, "@input.json" contains the sample input data.

Note

  • The name and ISO code of the currencies are defined and cannot be updated.

Request JSON

  • idstring, mandatory

    Specify the unique ID of the currency. Refer to Get Currencies API for more details.

  • prefix_symbolboolean, optional

    Represents the position of the ISO code in the currency.
    Possible values:
    true: Display ISO code before the currency value.
    false: Display ISO code after the currency value.

  • namestring, optional

    Represents the name of the currency.

  • iso_codestring, optional

    Represents the ISO code of the currency.

  • symbolstring, optional

    Represents the symbol of the currency.

  • exchange_ratestring, optional

    Represents the rate at which the currency has to be exchanged for home currency.

  • is_activeboolean, optional

    Represents the status of the currency.
    Possible values:
    true: The currency is active.
    false: The currency is inactive.

  • formatJSON object, optional

    Represents the format of the base currency with details like decimal_separator, thousand_separator, and decimal_places.

Keys to be specified in format JSON Object

  • decimal_separatorstring, optional

    The decimal separator separates the integer part of the currency from its fractional part. It can be a Period or Comma, depending on the currency.

  • thousand_separatorstring, optional

    The thousand separator separates groups of thousands in a currency. It can be a Period, Comma, or Space, depending on the currency.

  • decimal_placesinteger, optional

    Represents the number of decimal places allowed for the currency. It can be 0, 2, or 3.

Sample Input

Copied{
    "base_currency": {
        "symbol": "Af",
        "format": {
            "decimal_separator": "Period",
            "thousand_separator": "Comma",
            "decimal_places": "3"
        },
        "prefix_symbol": true,
        "id": "111113000000038990",
        "exchange_rate": "1.0000000"
    }
}

Possible Errors

  • INVALID_URL_PATTERNHTTP 404

    Please check if the URL trying to access is a correct one
    Resolution: The request URL has syntactical errors.

  • INVALID_DATAHTTP 400

    ID is invalid
    Resolution: You have specified an invalid currency ID.

  • INVALID_DATAHTTP 400

    Currency symbol is invalid.
    Resolution: You have specified an invalid currency symbol.

  • FEATURE_NOT_SUPPORTEDHTTP 403

    The multi-currency feature is not available except the Enterprise and higher editions.
    Resolution: The multi-currency feature is only available in Enterprise and Ultimate editions.

  • FEATURE_NOT_ENABLEDHTTP 403

    The multi-currency feature is not enabled.
    Resolution: You can update currencies only after enabling the multi-currency feature. Refer to Enable Multi-Currency.

  • NOT_ALLOWEDHTTP 400

    Thousand separator and decimal separator should not be equal
    Resolution: Specify different separators for thousands and decimals.

  • NOT_ALLOWEDHTTP 400

    Base currency ID is not allowed here
    Resolution: You cannot update the base currency values.

  • MANDATORY_NOT_FOUNDHTTP 400

    Required field not found.
    Resolution: Specify the unique ID of the currency in the input. Refer to Get Currencies API to get the unique ID of a currency.

  • OAUTH_SCOPE_MISMATCHHTTP 401

    Unauthorized
    Resolution: Client does not have ZohoCRM.settings.currencies.UPDATE scope. Create a new client with valid scope. Refer to scope section above.

  • NO_PERMISSIONHTTP 403

    Permission denied to update
    Resolution: The user does not have permission to update currencies. Contact your system administrator.

  • INTERNAL_ERRORHTTP 500

    Internal Server Error
    Resolution: Unexpected and unhandled exception in Server. Contact support team.

  • INVALID_REQUEST_METHODHTTP 400

    The http request method type is not a valid one
    Resolution: You have specified an invalid HTTP method to access the API URL. Specify a valid request method. Refer to endpoints section above.

  • AUTHORIZATION_FAILEDHTTP 400

    User does not have sufficient privilege to update currencies.
    Resolution: The user does not have the permission to update currencies. Contact your system administrator.

Sample Response

Copied{
    "base_currency": {
        "code": "SUCCESS",
        "details": {
            "id": "4150868000000780002"
        },
        "message": "The currency updated successfully",
        "status": "success"
    }
}