Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
set sbResponseBody [new_CkStringBuilder]
set success [CkHttp_QuickGetSb $http "https://domain.com/crm/v2.1/settings/email_templates" $sbResponseBody]
if {$success == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
exit
}
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttp_lastHeader $http]
puts "Failed."
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "email_templates": [
# {
# "created_time": "2021-02-04T14:22:19+05:30",
# "attachments": null,
# "subject": "Thank you mail",
# "module": {
# "api_name": "Contacts",
# "id": "4150868000000002179"
# },
# "type": "custom_templates",
# "created_by": {
# "name": "Patricia Boyle",
# "id": "4150868000000225013"
# },
# "modified_time": "2021-02-04T14:22:19+05:30",
# "folder": {
# "name": "Public Email Templates",
# "id": "4150868000000000077"
# },
# "last_usage_time": null,
# "associated": true,
# "name": "Thank you for registeration",
# "consent_linked": false,
# "modified_by": {
# "name": "Patricia Boyle",
# "id": "4150868000000225013"
# },
# "id": "4150868000004557001",
# "editor_mode": "gallery",
# "favorite": false
# },
# {
# "created_time": "2020-03-18T10:14:49+05:30",
# "attachments": null,
# "subject": "This is a sample email template",
# "module": {
# "api_name": "Contacts",
# "id": "4150868000000002179"
# },
# "type": "custom_templates",
# "created_by": {
# "name": "Patricia Boyle",
# "id": "4150868000000225013"
# },
# "modified_time": "2020-03-18T10:14:49+05:30",
# "folder": {
# "name": "Public Email Templates",
# "id": "4150868000000000077"
# },
# "last_usage_time": null,
# "associated": true,
# "name": "Sample1",
# "consent_linked": false,
# "modified_by": {
# "name": "Patricia Boyle",
# "id": "4150868000000225013"
# },
# "id": "4150868000001658001",
# "editor_mode": "gallery",
# "favorite": false
# },
# {
# "created_time": "2019-09-23T16:56:45+05:30",
# "attachments": null,
# "subject": "this is a test email",
# "module": {
# "api_name": "Leads",
# "id": "4150868000000002175"
# },
# "type": "custom_templates",
# "created_by": {
# "name": "Patricia Boyle",
# "id": "4150868000000225013"
# },
# "modified_time": "2019-09-23T16:56:45+05:30",
# "folder": {
# "name": "Public Email Templates",
# "id": "4150868000000000077"
# },
# "last_usage_time": "2019-09-29T20:00:03+05:30",
# "associated": true,
# "name": "Sample",
# "consent_linked": false,
# "modified_by": {
# "name": "Patricia Boyle",
# "id": "4150868000000225013"
# },
# "id": "4150868000000475003",
# "editor_mode": "gallery",
# "favorite": false
# },
# {
# "created_time": "2019-08-20T11:21:31+05:30",
# "attachments": null,
# "subject": "Big Deal Alert",
# "module": {
# "api_name": "Deals",
# "id": "4150868000000002181"
# },
# "type": "system_templates",
# "created_by": null,
# "modified_time": "2019-08-20T11:21:31+05:30",
# "folder": {
# "name": "Public Email Templates",
# "id": "4150868000000000077"
# },
# "last_usage_time": "2020-02-25T10:59:44+05:30",
# "associated": true,
# "name": "Big Deal Alert",
# "consent_linked": false,
# "modified_by": null,
# "id": "4150868000000000079",
# "editor_mode": "gallery",
# "favorite": false
# }
# ],
# "info": {
# "per_page": 200,
# "count": 4,
# "page": 1,
# "more_records": false
# }
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set Per_page [CkJsonObject_IntOf $jResp "info.per_page"]
set Count [CkJsonObject_IntOf $jResp "info.count"]
set Page [CkJsonObject_IntOf $jResp "info.page"]
set More_records [CkJsonObject_BoolOf $jResp "info.more_records"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "email_templates"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set created_time [CkJsonObject_stringOf $jResp "email_templates[i].created_time"]
set attachments [CkJsonObject_stringOf $jResp "email_templates[i].attachments"]
set subject [CkJsonObject_stringOf $jResp "email_templates[i].subject"]
set Api_name [CkJsonObject_stringOf $jResp "email_templates[i].module.api_name"]
set Id [CkJsonObject_stringOf $jResp "email_templates[i].module.id"]
set v_type [CkJsonObject_stringOf $jResp "email_templates[i].type"]
set Name [CkJsonObject_stringOf $jResp "email_templates[i].created_by.name"]
set created_byId [CkJsonObject_stringOf $jResp "email_templates[i].created_by.id"]
set modified_time [CkJsonObject_stringOf $jResp "email_templates[i].modified_time"]
set folderName [CkJsonObject_stringOf $jResp "email_templates[i].folder.name"]
set folderId [CkJsonObject_stringOf $jResp "email_templates[i].folder.id"]
set last_usage_time [CkJsonObject_stringOf $jResp "email_templates[i].last_usage_time"]
set associated [CkJsonObject_BoolOf $jResp "email_templates[i].associated"]
set name [CkJsonObject_stringOf $jResp "email_templates[i].name"]
set consent_linked [CkJsonObject_BoolOf $jResp "email_templates[i].consent_linked"]
set modified_byName [CkJsonObject_stringOf $jResp "email_templates[i].modified_by.name"]
set modified_byId [CkJsonObject_stringOf $jResp "email_templates[i].modified_by.id"]
set id [CkJsonObject_stringOf $jResp "email_templates[i].id"]
set editor_mode [CkJsonObject_stringOf $jResp "email_templates[i].editor_mode"]
set favorite [CkJsonObject_BoolOf $jResp "email_templates[i].favorite"]
set created_by [CkJsonObject_stringOf $jResp "email_templates[i].created_by"]
set modified_by [CkJsonObject_stringOf $jResp "email_templates[i].modified_by"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://domain.com/crm/v2.1/settings/email_templates
Postman Collection Item JSON
{
"name": "Email Templates",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{access-token}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/email_templates",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"email_templates"
]
}
},
"response": [
{
"name": "SUCCESS RESPONSE",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/email_templates",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"email_templates"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Mon, 10 May 2021 12:19:25 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
},
{
"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-10T18:42:26+05:30"
},
{
"key": "clientVersion",
"value": "4016246"
},
{
"key": "clientsubVersion",
"value": "59f8474ad0046d6a2f6204e0448818d0"
},
{
"key": "Content-Disposition",
"value": "attachment; filename=response.json"
},
{
"key": "vary",
"value": "accept-encoding"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Content-Language",
"value": "en-US"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=63072000"
}
],
"cookie": [
],
"body": "{\n \"email_templates\": [\n {\n \"created_time\": \"2021-02-04T14:22:19+05:30\",\n \"attachments\": null,\n \"subject\": \"Thank you mail\",\n \"module\": {\n \"api_name\": \"Contacts\",\n \"id\": \"4150868000000002179\"\n },\n \"type\": \"custom_templates\",\n \"created_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\"\n },\n \"modified_time\": \"2021-02-04T14:22:19+05:30\",\n \"folder\": {\n \"name\": \"Public Email Templates\",\n \"id\": \"4150868000000000077\"\n },\n \"last_usage_time\": null,\n \"associated\": true,\n \"name\": \"Thank you for registeration\",\n \"consent_linked\": false,\n \"modified_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\"\n },\n \"id\": \"4150868000004557001\",\n \"editor_mode\": \"gallery\",\n \"favorite\": false\n },\n {\n \"created_time\": \"2020-03-18T10:14:49+05:30\",\n \"attachments\": null,\n \"subject\": \"This is a sample email template\",\n \"module\": {\n \"api_name\": \"Contacts\",\n \"id\": \"4150868000000002179\"\n },\n \"type\": \"custom_templates\",\n \"created_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\"\n },\n \"modified_time\": \"2020-03-18T10:14:49+05:30\",\n \"folder\": {\n \"name\": \"Public Email Templates\",\n \"id\": \"4150868000000000077\"\n },\n \"last_usage_time\": null,\n \"associated\": true,\n \"name\": \"Sample1\",\n \"consent_linked\": false,\n \"modified_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\"\n },\n \"id\": \"4150868000001658001\",\n \"editor_mode\": \"gallery\",\n \"favorite\": false\n },\n {\n \"created_time\": \"2019-09-23T16:56:45+05:30\",\n \"attachments\": null,\n \"subject\": \"this is a test email\",\n \"module\": {\n \"api_name\": \"Leads\",\n \"id\": \"4150868000000002175\"\n },\n \"type\": \"custom_templates\",\n \"created_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\"\n },\n \"modified_time\": \"2019-09-23T16:56:45+05:30\",\n \"folder\": {\n \"name\": \"Public Email Templates\",\n \"id\": \"4150868000000000077\"\n },\n \"last_usage_time\": \"2019-09-29T20:00:03+05:30\",\n \"associated\": true,\n \"name\": \"Sample\",\n \"consent_linked\": false,\n \"modified_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\"\n },\n \"id\": \"4150868000000475003\",\n \"editor_mode\": \"gallery\",\n \"favorite\": false\n },\n {\n \"created_time\": \"2019-08-20T11:21:31+05:30\",\n \"attachments\": null,\n \"subject\": \"Big Deal Alert\",\n \"module\": {\n \"api_name\": \"Deals\",\n \"id\": \"4150868000000002181\"\n },\n \"type\": \"system_templates\",\n \"created_by\": null,\n \"modified_time\": \"2019-08-20T11:21:31+05:30\",\n \"folder\": {\n \"name\": \"Public Email Templates\",\n \"id\": \"4150868000000000077\"\n },\n \"last_usage_time\": \"2020-02-25T10:59:44+05:30\",\n \"associated\": true,\n \"name\": \"Big Deal Alert\",\n \"consent_linked\": false,\n \"modified_by\": null,\n \"id\": \"4150868000000000079\",\n \"editor_mode\": \"gallery\",\n \"favorite\": false\n }\n ],\n \"info\": {\n \"per_page\": 200,\n \"count\": 4,\n \"page\": 1,\n \"more_records\": false\n }\n}"
},
{
"name": "AUTHENTICATION_FAILURE",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/email_templates",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"email_templates"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Mon, 10 May 2021 12:21:01 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_URL_PATTERN",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/email_template",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"email_template"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Mon, 10 May 2021 12:21:23 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-10T18:42:26+05:30"
},
{
"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": "OAUTH_SCOPE_MISMATCH",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/email_templates",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"email_templates"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Thu, 13 May 2021 08:43:48 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "113"
},
{
"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\": \"OAUTH_SCOPE_MISMATCH\",\n \"details\": {},\n \"message\": \"invalid oauth scope to access this URL\",\n \"status\": \"error\"\n}"
}
]
}
