Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
# Use this online tool to generate code from sample JSON: Generate Code to Create JSON
# The following JSON is sent in the request body.
# {
# "base_currency": {
# "symbol": "Af",
# "format": {
# "decimal_separator": "Period",
# "thousand_separator": "Comma",
# "decimal_places": "3"
# },
# "prefix_symbol": true,
# "id": "{{currency_id}}",
# "exchange_rate": "1.0000000"
# }
# }
json = Chilkat::CkJsonObject.new()
json.UpdateString("base_currency.symbol","Af")
json.UpdateString("base_currency.format.decimal_separator","Period")
json.UpdateString("base_currency.format.thousand_separator","Comma")
json.UpdateString("base_currency.format.decimal_places","3")
json.UpdateBool("base_currency.prefix_symbol",true)
json.UpdateString("base_currency.id","{{currency_id}}")
json.UpdateString("base_currency.exchange_rate","1.0000000")
# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")
sbRequestBody = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequestBody)
# resp is a CkHttpResponse
resp = http.PTextSb("PUT","https://domain.com/crm/v2.1/org/currencies/actions/enable",sbRequestBody,"utf-8","application/json",false,false)
if (http.get_LastMethodSuccess() == false)
print http.lastErrorText() + "\n";
exit
end
sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jResp.emit() + "\n";
respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
print "Response Header:" + "\n";
print resp.header() + "\n";
print "Failed." + "\n";
exit
end
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "base_currency": {
# "code": "SUCCESS",
# "details": {
# "id": "738964000000650003"
# },
# "message": "The currency updated successfully.",
# "status": "success"
# }
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Code = jResp.stringOf("base_currency.code")
Id = jResp.stringOf("base_currency.details.id")
Message = jResp.stringOf("base_currency.message")
Status = jResp.stringOf("base_currency.status")
Curl Command
curl -X PUT
-H "Authorization: Bearer <access_token>"
-d '{
"base_currency": {
"symbol": "Af",
"format": {
"decimal_separator": "Period",
"thousand_separator": "Comma",
"decimal_places": "3"
},
"prefix_symbol": true,
"id": "{{currency_id}}",
"exchange_rate": "1.0000000"
}
}'
https://domain.com/crm/v2.1/org/currencies/actions/enable
Postman Collection Item JSON
{
"name": "Update Currencies",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{access-token}}",
"type": "string"
}
]
},
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"base_currency\": {\n \"symbol\": \"Af\",\n \"format\": {\n \"decimal_separator\": \"Period\",\n \"thousand_separator\": \"Comma\",\n \"decimal_places\": \"3\"\n },\n \"prefix_symbol\": true,\n \"id\": \"{{currency_id}}\",\n \"exchange_rate\": \"1.0000000\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2.1/org/currencies/actions/enable",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"org",
"currencies",
"actions",
"enable"
]
},
"description": "To update currency details."
},
"response": [
{
"name": "SUCCESS RESPONSE",
"originalRequest": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"base_currency\": {\n \"symbol\": \"Af\",\n \"format\": {\n \"decimal_separator\": \"Period\",\n \"thousand_separator\": \"Comma\",\n \"decimal_places\": \"3\"\n },\n \"prefix_symbol\": true,\n \"id\": \"738964000000650003\",\n \"exchange_rate\": \"1.0000000\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2.1/org/currencies/actions/enable",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"org",
"currencies",
"actions",
"enable"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Fri, 07 May 2021 13:23:27 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "140"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-ACCESSTOKEN-RESET",
"value": "2021-05-07T14:14:22+00:00"
},
{
"key": "clientVersion",
"value": "4016256"
},
{
"key": "clientsubVersion",
"value": "8ef7aa3133ce0e105307c407d89b23d9"
},
{
"key": "Content-Disposition",
"value": "attachment; filename=response.json"
},
{
"key": "Content-Language",
"value": "en-US"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=15768000"
}
],
"cookie": [
],
"body": "{\n \"base_currency\": {\n \"code\": \"SUCCESS\",\n \"details\": {\n \"id\": \"738964000000650003\"\n },\n \"message\": \"The currency updated successfully.\",\n \"status\": \"success\"\n }\n}"
},
{
"name": "INVALID_URL_PATTERN",
"originalRequest": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"base_currency\": {\n \"symbol\": \"Af\",\n \"format\": {\n \"decimal_separator\": \"Period\",\n \"thousand_separator\": \"Comma\",\n \"decimal_places\": \"3\"\n },\n \"prefix_symbol\": true,\n \"id\": \"738964000000650003\",\n \"exchange_rate\": \"1.0000000\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2.1/org/currencies/actions/enabl",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"org",
"currencies",
"actions",
"enabl"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Fri, 07 May 2021 13:24:07 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "131"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-ACCESSTOKEN-RESET",
"value": "2021-05-07T14:14:22+00:00"
},
{
"key": "Content-Disposition",
"value": "attachment; filename=response.json"
},
{
"key": "X-Download-Options",
"value": "noopen"
},
{
"key": "Content-Language",
"value": "en-US"
}
],
"cookie": [
],
"body": "{\n \"code\": \"INVALID_URL_PATTERN\",\n \"details\": {},\n \"message\": \"Please check if the URL trying to access is a correct one\",\n \"status\": \"error\"\n}"
},
{
"name": "INVALID_DATA (currency ID)",
"originalRequest": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"base_currency\": {\n \"symbol\": \"Af\",\n \"format\": {\n \"decimal_separator\": \"Period\",\n \"thousand_separator\": \"Comma\",\n \"decimal_places\": \"3\"\n },\n \"prefix_symbol\": true,\n \"id\": \"73896400000065000\",\n \"exchange_rate\": \"1.0000000\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2.1/org/currencies/actions/enable",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"org",
"currencies",
"actions",
"enable"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Fri, 07 May 2021 13:24:35 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "155"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-ACCESSTOKEN-RESET",
"value": "2021-05-07T14:14:22+00:00"
},
{
"key": "clientVersion",
"value": "4016256"
},
{
"key": "clientsubVersion",
"value": "8ef7aa3133ce0e105307c407d89b23d9"
},
{
"key": "Content-Disposition",
"value": "attachment; filename=response.json"
},
{
"key": "Content-Language",
"value": "en-US"
}
],
"cookie": [
],
"body": "{\n \"base_currency\": {\n \"code\": \"INVALID_DATA\",\n \"details\": {\n \"api_name\": \"id\",\n \"json_path\": \"$.base_currency.id\"\n },\n \"message\": \"Currency id is invalid.\",\n \"status\": \"error\"\n }\n}"
},
{
"name": "INVALID_DATA (currency symbol)",
"originalRequest": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"base_currency\": {\n \"symbol\": \"test\",\n \"format\": {\n \"decimal_separator\": \"Period\",\n \"thousand_separator\": \"Comma\",\n \"decimal_places\": \"3\"\n },\n \"prefix_symbol\": true,\n \"id\": \"738964000000650003\",\n \"exchange_rate\": \"1.0000000\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2.1/org/currencies/actions/enable",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"org",
"currencies",
"actions",
"enable"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Fri, 07 May 2021 13:24:59 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "168"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-ACCESSTOKEN-RESET",
"value": "2021-05-07T14:14:22+00:00"
},
{
"key": "clientVersion",
"value": "4016256"
},
{
"key": "clientsubVersion",
"value": "8ef7aa3133ce0e105307c407d89b23d9"
},
{
"key": "Content-Disposition",
"value": "attachment; filename=response.json"
},
{
"key": "Content-Language",
"value": "en-US"
}
],
"cookie": [
],
"body": "{\n \"base_currency\": {\n \"code\": \"INVALID_DATA\",\n \"details\": {\n \"api_name\": \"symbol\",\n \"json_path\": \"$.base_currency.symbol\"\n },\n \"message\": \"Currency symbol is invalid.\",\n \"status\": \"error\"\n }\n}"
},
{
"name": "NOT_ALLOWED",
"originalRequest": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"base_currency\": {\n \"symbol\": \"Af\",\n \"format\": {\n \"decimal_separator\": \"Period\",\n \"thousand_separator\": \"Period\",\n \"decimal_places\": \"3\"\n },\n \"prefix_symbol\": true,\n \"id\": \"738964000000650003\",\n \"exchange_rate\": \"1.0000000\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2.1/org/currencies/actions/enable",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"org",
"currencies",
"actions",
"enable"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Fri, 07 May 2021 13:26:14 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "222"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-ACCESSTOKEN-RESET",
"value": "2021-05-07T14:14:22+00:00"
},
{
"key": "clientVersion",
"value": "4016256"
},
{
"key": "clientsubVersion",
"value": "8ef7aa3133ce0e105307c407d89b23d9"
},
{
"key": "Content-Disposition",
"value": "attachment; filename=response.json"
},
{
"key": "Content-Language",
"value": "en-US"
}
],
"cookie": [
],
"body": "{\n \"base_currency\": {\n \"code\": \"NOT_ALLOWED\",\n \"details\": {\n \"api_name\": \"decimal_places\",\n \"json_path\": \"$.base_currency.format.decimal_places\"\n },\n \"message\": \"Thousand separator and decimal separator should not be equal\",\n \"status\": \"error\"\n }\n}"
},
{
"name": "MANDATORY_NOT_FOUND",
"originalRequest": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"base_currency\": {\n \"symbol\": \"Af\",\n \"format\": {\n \"decimal_separator\": \"Period\",\n \"thousand_separator\": \"Comma\",\n \"decimal_places\": \"3\"\n },\n \"prefix_symbol\": true,\n \"exchange_rate\": \"1.0000000\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2.1/org/currencies/actions/enable",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"org",
"currencies",
"actions",
"enable"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Fri, 07 May 2021 13:26:42 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "163"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-ACCESSTOKEN-RESET",
"value": "2021-05-07T14:14:22+00:00"
},
{
"key": "clientVersion",
"value": "4016256"
},
{
"key": "clientsubVersion",
"value": "8ef7aa3133ce0e105307c407d89b23d9"
},
{
"key": "Content-Disposition",
"value": "attachment; filename=response.json"
},
{
"key": "Content-Language",
"value": "en-US"
}
],
"cookie": [
],
"body": "{\n \"base_currency\": {\n \"code\": \"MANDATORY_NOT_FOUND\",\n \"details\": {\n \"api_name\": \"id\",\n \"json_path\": \"$.base_currency.id\"\n },\n \"message\": \"required field not found\",\n \"status\": \"error\"\n }\n}"
},
{
"name": "INVALID_REQUEST_METHOD",
"originalRequest": {
"method": "COPY",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"base_currency\": {\n \"symbol\": \"Af\",\n \"format\": {\n \"decimal_separator\": \"Period\",\n \"thousand_separator\": \"Comma\",\n \"decimal_places\": \"3\"\n },\n \"prefix_symbol\": true,\n \"exchange_rate\": \"1.0000000\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2.1/org/currencies/actions/enable",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"org",
"currencies",
"actions",
"enable"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Fri, 07 May 2021 13:27:00 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "124"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "X-Frame-Options",
"value": "deny"
},
{
"key": "X-Download-Options",
"value": "noopen"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
}
],
"cookie": [
],
"body": "{\n \"code\": \"INVALID_REQUEST_METHOD\",\n \"details\": {},\n \"message\": \"The http request method type is not a valid one\",\n \"status\": \"error\"\n}"
},
{
"name": "AUTHENTICATION_FAILURE",
"originalRequest": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"base_currency\": {\n \"symbol\": \"Af\",\n \"format\": {\n \"decimal_separator\": \"Period\",\n \"thousand_separator\": \"Comma\",\n \"decimal_places\": \"3\"\n },\n \"prefix_symbol\": true,\n \"exchange_rate\": \"1.0000000\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2.1/org/currencies/actions/enable",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"org",
"currencies",
"actions",
"enable"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Fri, 07 May 2021 13:27:22 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "98"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-Download-Options",
"value": "noopen"
}
],
"cookie": [
],
"body": "{\n \"code\": \"AUTHENTICATION_FAILURE\",\n \"details\": {},\n \"message\": \"Authentication failed\",\n \"status\": \"error\"\n}"
}
]
}
