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]
CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "login"
CkHttp_put_Password $http "password"
# Use this online tool to generate code from sample JSON: Generate Code to Create JSON
# The following JSON is sent in the request body.
# {
# "macro": {
# "title": "<string>",
# "actions": [
# {
# "field": "<string>",
# "value": "<string>"
# },
# {
# "field": "<string>",
# "value": "<string>"
# }
# ],
# "active": "<boolean>",
# "description": "<string>",
# "restriction": {
# "id": "<integer>",
# "ids": [
# "<integer>",
# "<integer>"
# ],
# "type": "<string>",
# "dolore_dc": "velit irure",
# "ullamco368": 46888012
# }
# }
# }
set json [new_CkJsonObject]
CkJsonObject_UpdateString $json "macro.title" "<string>"
CkJsonObject_UpdateString $json "macro.actions[0].field" "<string>"
CkJsonObject_UpdateString $json "macro.actions[0].value" "<string>"
CkJsonObject_UpdateString $json "macro.actions[1].field" "<string>"
CkJsonObject_UpdateString $json "macro.actions[1].value" "<string>"
CkJsonObject_UpdateString $json "macro.active" "<boolean>"
CkJsonObject_UpdateString $json "macro.description" "<string>"
CkJsonObject_UpdateString $json "macro.restriction.id" "<integer>"
CkJsonObject_UpdateString $json "macro.restriction.ids[0]" "<integer>"
CkJsonObject_UpdateString $json "macro.restriction.ids[1]" "<integer>"
CkJsonObject_UpdateString $json "macro.restriction.type" "<string>"
CkJsonObject_UpdateString $json "macro.restriction.dolore_dc" "velit irure"
CkJsonObject_UpdateInt $json "macro.restriction.ullamco368" 46888012
CkHttp_SetRequestHeader $http "Content-Type" "application/json"
CkHttp_SetRequestHeader $http "Accept" "application/json"
# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://example.zendesk.com/api/v2/macros" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $json
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "macro": {
# "actions": [
# {
# "field": "<string>",
# "value": "<string>"
# },
# {
# "field": "<string>",
# "value": "<string>"
# }
# ],
# "title": "<string>",
# "active": "<boolean>",
# "created_at": "<dateTime>",
# "default": "<boolean>",
# "description": "<string>",
# "id": "<integer>",
# "position": "<integer>",
# "restriction": {
# "utc": -57663786.73485631,
# "sint_c": 56026975.00248328
# },
# "updated_at": "<dateTime>",
# "url": "<string>",
# "app_installation": "<string>",
# "categories": "<string>",
# "permissions": "<string>",
# "usage_1h": "<integer>",
# "usage_7d": "<integer>",
# "usage_24h": "<integer>",
# "usage_30d": "<integer>"
# }
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set Title [CkJsonObject_stringOf $jResp "macro.title"]
set Active [CkJsonObject_stringOf $jResp "macro.active"]
set Created_at [CkJsonObject_stringOf $jResp "macro.created_at"]
set Default [CkJsonObject_stringOf $jResp "macro.default"]
set Description [CkJsonObject_stringOf $jResp "macro.description"]
set Id [CkJsonObject_stringOf $jResp "macro.id"]
set Position [CkJsonObject_stringOf $jResp "macro.position"]
set Utc [CkJsonObject_stringOf $jResp "macro.restriction.utc"]
set Sint_c [CkJsonObject_stringOf $jResp "macro.restriction.sint_c"]
set Updated_at [CkJsonObject_stringOf $jResp "macro.updated_at"]
set v_Url [CkJsonObject_stringOf $jResp "macro.url"]
set App_installation [CkJsonObject_stringOf $jResp "macro.app_installation"]
set Categories [CkJsonObject_stringOf $jResp "macro.categories"]
set Permissions [CkJsonObject_stringOf $jResp "macro.permissions"]
set Usage_1h [CkJsonObject_stringOf $jResp "macro.usage_1h"]
set Usage_7d [CkJsonObject_stringOf $jResp "macro.usage_7d"]
set Usage_24h [CkJsonObject_stringOf $jResp "macro.usage_24h"]
set Usage_30d [CkJsonObject_stringOf $jResp "macro.usage_30d"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "macro.actions"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set field [CkJsonObject_stringOf $jResp "macro.actions[i].field"]
set value [CkJsonObject_stringOf $jResp "macro.actions[i].value"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -u login:password -X POST
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"macro": {
"title": "<string>",
"actions": [
{
"field": "<string>",
"value": "<string>"
},
{
"field": "<string>",
"value": "<string>"
}
],
"active": "<boolean>",
"description": "<string>",
"restriction": {
"id": "<integer>",
"ids": [
"<integer>",
"<integer>"
],
"type": "<string>",
"dolore_dc": "velit irure",
"ullamco368": 46888012
}
}
}'
https://example.zendesk.com/api/v2/macros
Postman Collection Item JSON
{
"name": "Create Macro",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"macro\": {\n \"title\": \"<string>\",\n \"actions\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"active\": \"<boolean>\",\n \"description\": \"<string>\",\n \"restriction\": {\n \"id\": \"<integer>\",\n \"ids\": [\n \"<integer>\",\n \"<integer>\"\n ],\n \"type\": \"<string>\",\n \"dolore_dc\": \"velit irure\",\n \"ullamco368\": 46888012\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/macros",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"macros"
]
},
"description": "#### Allowed For\n* Agents\n"
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"macro\": {\n \"title\": \"<string>\",\n \"actions\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"active\": \"<boolean>\",\n \"description\": \"<string>\",\n \"restriction\": {\n \"id\": \"<integer>\",\n \"ids\": [\n \"<integer>\",\n \"<integer>\"\n ],\n \"type\": \"<string>\",\n \"dolore_dc\": \"velit irure\",\n \"ullamco368\": 46888012\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/macros",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"macros"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"macro\": {\n \"actions\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"title\": \"<string>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"restriction\": {\n \"utc\": -57663786.73485631,\n \"sint_c\": 56026975.00248328\n },\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\",\n \"app_installation\": \"<string>\",\n \"categories\": \"<string>\",\n \"permissions\": \"<string>\",\n \"usage_1h\": \"<integer>\",\n \"usage_7d\": \"<integer>\",\n \"usage_24h\": \"<integer>\",\n \"usage_30d\": \"<integer>\"\n }\n}"
}
]
}