Update Currencies
Purpose
To update currency details.
Request URL
To update home currency:
https://www.zohoapis.com/crm/v2/org/currencies
To update currencies other than home currency:
https://www.zohoapis.com/crm/v2/org/currencies/actions/enable
Request Method
PUT
Scope
scope=ZohoCRM.settings.currencies.{operation_type}
Possible operation types |
---|
UPDATE - Update currencies data |
Note:
The name and ISO code of the currencies are defined and cannot be updated.
Request JSON
Attribute | Data Type | Mandatory | Description |
---|---|---|---|
decimal_separator | String | Yes | 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_separator | String | Yes | The thousand separator separates groups of thousands in a currency. It can be a Period, Comma, or Space, depending on the currency. |
decimal_places | Integer | Yes | Represents the number of decimal places allowed for the currency. It can be 0, 2, or 3. |
prefix_symbol | Boolean | No | Represents the position of the ISO code in the currency. true: Display ISO code before the currency value. false: Display ISO code after the currency value. |
name | String | Yes | Represents the name of the currency. |
iso_code | String | Yes | Represents the ISO code of the currency. |
symbol | String | Yes | Represents the symbol of the currency. |
exchange_rate | String | Yes | Represents the rate at which the currency has to be exchanged for home currency. |
is_active | Boolean | No | Represents the status of the currency. true: The currency is active. false: The currency is inactive. |
Possible Errors
HTTP Status | Error Code | Message | Reason |
---|---|---|---|
404 | INVALID_URL_PATTERN | Please check if the URL trying to access is a correct one | The request URL has syntactical errors. |
400 | INVALID_DATA | ID is invalid | You have specified an invalid currency ID |
400 | INVALID_DATA | Currency symbol is invalid. | You have specified an invalid currency symbol. |
403 | FEATURE_NOT_SUPPORTED | The multi-currency feature is not available except the Enterprise and higher editions. | The multi-currency feature is only available in Enterprise and Ultimate editions. |
403 | FEATURE_NOT_ENABLED | The multi-currency feature is not enabled. | You can update currencies only after enabling the multi-currency feature. Refer to Enable Multi-Currency. |
400 | NOT_ALLOWED | Thousand separator and decimal separator should not be equal | Specify different separators for thousands and decimals. |
400 | NOT_ALLOWED | Base currency ID is not allowed here | You cannot update the base currency values. |
Sample Request To Update Home Currency
Copiedcurl "https://www.zohoapis.com/crm/v2/org/currencies/actions/enable"
-X PUT
-d input.json
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"