Back to Collection Items
<?php
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
$http = new COM("Chilkat_9_5_0.Http");
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "currencies": [
// {
// "format": {
// "decimal_separator": "Period",
// "thousand_separator": "Comma",
// "decimal_places": "2"
// },
// "prefix_symbol": true,
// "name": "Saudi Riyal - SAR",
// "iso_code": "SAR",
// "symbol": "SR",
// "exchange_rate": "1.0000000",
// "is_active": true
// }
// ]
// }
$json = new COM("Chilkat_9_5_0.JsonObject");
$json->UpdateString('currencies[0].format.decimal_separator','Period');
$json->UpdateString('currencies[0].format.thousand_separator','Comma');
$json->UpdateString('currencies[0].format.decimal_places','2');
$json->UpdateBool('currencies[0].prefix_symbol',1);
$json->UpdateString('currencies[0].name','Saudi Riyal - SAR');
$json->UpdateString('currencies[0].iso_code','SAR');
$json->UpdateString('currencies[0].symbol','SR');
$json->UpdateString('currencies[0].exchange_rate','1.0000000');
$json->UpdateBool('currencies[0].is_active',1);
// Adds the "Authorization: Bearer <access_token>" header.
$http->AuthToken = '<access_token>';
// resp is a Chilkat_9_5_0.HttpResponse
$resp = $http->PostJson3('https://domain.com/crm/v2/org/currencies','application/json',$json);
if ($http->LastMethodSuccess == 0) {
print $http->LastErrorText . "\n";
exit;
}
$sbResponseBody = new COM("Chilkat_9_5_0.StringBuilder");
$resp->GetBodySb($sbResponseBody);
$jResp = new COM("Chilkat_9_5_0.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $resp->StatusCode;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
print 'Response Header:' . "\n";
print $resp->Header . "\n";
print 'Failed.' . "\n";
exit;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "currencies": [
// {
// "code": "SUCCESS",
// "details": {
// "id": "738964000002152100"
// },
// "message": "The currency created 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
$i = 0;
$count_i = $jResp->SizeOfArray('currencies');
while ($i < $count_i) {
$jResp->I = $i;
$code = $jResp->stringOf('currencies[i].code');
$Id = $jResp->stringOf('currencies[i].details.id');
$message = $jResp->stringOf('currencies[i].message');
$status = $jResp->stringOf('currencies[i].status');
$i = $i + 1;
}
?>
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-d '{
"currencies": [
{
"format": {
"decimal_separator": "Period",
"thousand_separator": "Comma",
"decimal_places": "2"
},
"prefix_symbol": true,
"name": "Saudi Riyal - SAR",
"iso_code": "SAR",
"symbol": "SR",
"exchange_rate": "1.0000000",
"is_active": true
}
]
}'
https://domain.com/crm/v2/org/currencies
Postman Collection Item JSON
{
"name": "Add Currencies",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{access-token}}",
"type": "string"
}
]
},
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"currencies\": [\n {\n \"format\": {\n \"decimal_separator\": \"Period\",\n \"thousand_separator\": \"Comma\",\n \"decimal_places\": \"2\"\n },\n \"prefix_symbol\": true,\n \"name\": \"Saudi Riyal - SAR\",\n \"iso_code\": \"SAR\",\n \"symbol\": \"SR\",\n \"exchange_rate\": \"1.0000000\",\n \"is_active\": true\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2/org/currencies",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"org",
"currencies"
]
},
"description": "To add new currencies to your organization."
},
"response": [
{
"name": "SUCCESS RESPONSE",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"currencies\": [\n {\n \"format\": {\n \"decimal_separator\": \"Period\",\n \"thousand_separator\": \"Comma\",\n \"decimal_places\": \"2\"\n },\n \"prefix_symbol\": true,\n \"name\": \"Algerian Dinar - DZD\",\n \"iso_code\": \"DZD\",\n \"symbol\": \"DZD\",\n \"exchange_rate\": \"1.0000000\",\n \"is_active\": true\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2/org/currencies",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"org",
"currencies"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 12 May 2021 07:08:34 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "139"
},
{
"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-store, no-cache, must-revalidate, private"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-ACCESSTOKEN-RESET",
"value": "2021-05-12T07:56:48+00:00"
},
{
"key": "clientVersion",
"value": "4027076"
},
{
"key": "clientsubVersion",
"value": "748ecbe82ec7e144b66ee25f264bbd88"
},
{
"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 \"currencies\": [\n {\n \"code\": \"SUCCESS\",\n \"details\": {\n \"id\": \"738964000002152100\"\n },\n \"message\": \"The currency created successfully.\",\n \"status\": \"success\"\n }\n ]\n}"
},
{
"name": "DUPLICATE_DATA",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"currencies\": [\n {\n \"format\": {\n \"decimal_separator\": \"Period\",\n \"thousand_separator\": \"Comma\",\n \"decimal_places\": \"2\"\n },\n \"prefix_symbol\": true,\n \"name\": \"Saudi Riyal - SAR\",\n \"iso_code\": \"SAR\",\n \"symbol\": \"SR\",\n \"exchange_rate\": \"1.0000000\",\n \"is_active\": true\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2/org/currencies",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"org",
"currencies"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 12 May 2021 07:01:28 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "192"
},
{
"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-store, no-cache, must-revalidate, private"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-ACCESSTOKEN-RESET",
"value": "2021-05-12T07:56:48+00:00"
},
{
"key": "clientVersion",
"value": "4027076"
},
{
"key": "clientsubVersion",
"value": "748ecbe82ec7e144b66ee25f264bbd88"
},
{
"key": "Content-Disposition",
"value": "attachment; filename=response.json"
},
{
"key": "Content-Language",
"value": "en-US"
}
],
"cookie": [
],
"body": "{\n \"currencies\": [\n {\n \"code\": \"DUPLICATE_DATA\",\n \"details\": {\n \"api_name\": \"iso_code\",\n \"json_path\": \"$.currencies[0].iso_code\"\n },\n \"message\": \"Duplicate value given for \\\"Isocode\\\" parameter\",\n \"status\": \"error\"\n }\n ]\n}"
},
{
"name": "INVALID_DATA (iso code)",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"currencies\": [\n {\n \"format\": {\n \"decimal_separator\": \"Period\",\n \"thousand_separator\": \"Comma\",\n \"decimal_places\": \"2\"\n },\n \"prefix_symbol\": true,\n \"name\": test,\n \"iso_code\": test,\n \"exchange_rate\": \"1.0000000\",\n \"is_active\": true\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2/org/currencies",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"org",
"currencies"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 12 May 2021 07:18:15 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "171"
},
{
"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-store, no-cache, must-revalidate, private"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-ACCESSTOKEN-RESET",
"value": "2021-05-12T07:56:48+00:00"
},
{
"key": "clientVersion",
"value": "4027076"
},
{
"key": "clientsubVersion",
"value": "748ecbe82ec7e144b66ee25f264bbd88"
},
{
"key": "Content-Disposition",
"value": "attachment; filename=response.json"
},
{
"key": "Content-Language",
"value": "en-US"
}
],
"cookie": [
],
"body": "{\n \"currencies\": [\n {\n \"code\": \"INVALID_DATA\",\n \"details\": {\n \"api_name\": \"iso_code\",\n \"json_path\": \"$.currencies[0].iso_code\"\n },\n \"message\": \"Currency isocode is invalid.\",\n \"status\": \"error\"\n }\n ]\n}"
},
{
"name": "INVALID_DATA (currency name)",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"currencies\": [\n {\n \"format\": {\n \"decimal_separator\": \"Period\",\n \"thousand_separator\": \"Comma\",\n \"decimal_places\": \"2\"\n },\n \"prefix_symbol\": true,\n \"name\": \"test\",\n \"iso_code\": \"AOA\",\n \"exchange_rate\": \"1.0000000\",\n \"is_active\": true\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2/org/currencies",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"org",
"currencies"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 12 May 2021 07:18:39 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "161"
},
{
"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-store, no-cache, must-revalidate, private"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-ACCESSTOKEN-RESET",
"value": "2021-05-12T07:56:48+00:00"
},
{
"key": "clientVersion",
"value": "4027076"
},
{
"key": "clientsubVersion",
"value": "748ecbe82ec7e144b66ee25f264bbd88"
},
{
"key": "Content-Disposition",
"value": "attachment; filename=response.json"
},
{
"key": "Content-Language",
"value": "en-US"
}
],
"cookie": [
],
"body": "{\n \"currencies\": [\n {\n \"code\": \"INVALID_DATA\",\n \"details\": {\n \"api_name\": \"name\",\n \"json_path\": \"$.currencies[0].name\"\n },\n \"message\": \"Currency name is invalid.\",\n \"status\": \"error\"\n }\n ]\n}"
},
{
"name": "MANDATORY_NOT_FOUND",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"currencies\": [\n {\n \"format\": {\n \"decimal_separator\": \"Period\",\n \"thousand_separator\": \"Comma\",\n \"decimal_places\": \"2\"\n },\n \"prefix_symbol\": true,\n \"name\": \"test\",\n \n \"exchange_rate\": \"1.0000000\",\n \"is_active\": true\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2/org/currencies",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"org",
"currencies"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 12 May 2021 07:19:09 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "174"
},
{
"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-store, no-cache, must-revalidate, private"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-ACCESSTOKEN-RESET",
"value": "2021-05-12T07:56:48+00:00"
},
{
"key": "clientVersion",
"value": "4027076"
},
{
"key": "clientsubVersion",
"value": "748ecbe82ec7e144b66ee25f264bbd88"
},
{
"key": "Content-Disposition",
"value": "attachment; filename=response.json"
},
{
"key": "Content-Language",
"value": "en-US"
}
],
"cookie": [
],
"body": "{\n \"currencies\": [\n {\n \"code\": \"MANDATORY_NOT_FOUND\",\n \"details\": {\n \"api_name\": \"iso_code\",\n \"json_path\": \"$.currencies[0].iso_code\"\n },\n \"message\": \"required field not found\",\n \"status\": \"error\"\n }\n ]\n}"
},
{
"name": "INVALID_REQUEST_METHOD",
"originalRequest": {
"method": "COPY",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"currencies\": [\n {\n \"format\": {\n \"decimal_separator\": \"Period\",\n \"thousand_separator\": \"Comma\",\n \"decimal_places\": \"2\"\n },\n \"prefix_symbol\": true,\n \"name\": \"test\",\n \n \"exchange_rate\": \"1.0000000\",\n \"is_active\": true\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2/org/currencies",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"org",
"currencies"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 12 May 2021 07:19:22 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": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"currencies\": [\n {\n \"format\": {\n \"decimal_separator\": \"Period\",\n \"thousand_separator\": \"Comma\",\n \"decimal_places\": \"2\"\n },\n \"prefix_symbol\": true,\n \"name\": \"test\",\n \n \"exchange_rate\": \"1.0000000\",\n \"is_active\": true\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2/org/currencies",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"org",
"currencies"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 12 May 2021 07:19:35 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}"
},
{
"name": "INVALID_REQUEST",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"currencies\": [\n {\n \"format\": {\n \"decimal_separator\": \"Period\",\n \"thousand_separator\": \"Comma\",\n \"decimal_places\": \"2\"\n },\n \"prefix_symbol\": true,\n \"name\": \"Saudi Riyal - SAR\",\n \"iso_code\": \"SAR\",\n \"symbol\": \"SR\",\n \"exchange_rate\": \"1.0000000\",\n \"is_active\": true\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2/org/currencies",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"org",
"currencies"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Thu, 13 May 2021 06:43:06 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "192"
},
{
"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\": \"INVALID_REQUEST\",\n \"details\": {},\n \"message\": \"unable to process your request. please verify whether you have entered proper method name, parameter and parameter values.\",\n \"status\": \"error\"\n}"
}
]
}
