Python / Support API / Create Macro
Back to Collection Items
import sys
import chilkat
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = chilkat.CkHttp()
http.put_BasicAuth(True)
http.put_Login("login")
http.put_Password("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
# }
# }
# }
json = chilkat.CkJsonObject()
json.UpdateString("macro.title","<string>")
json.UpdateString("macro.actions[0].field","<string>")
json.UpdateString("macro.actions[0].value","<string>")
json.UpdateString("macro.actions[1].field","<string>")
json.UpdateString("macro.actions[1].value","<string>")
json.UpdateString("macro.active","<boolean>")
json.UpdateString("macro.description","<string>")
json.UpdateString("macro.restriction.id","<integer>")
json.UpdateString("macro.restriction.ids[0]","<integer>")
json.UpdateString("macro.restriction.ids[1]","<integer>")
json.UpdateString("macro.restriction.type","<string>")
json.UpdateString("macro.restriction.dolore_dc","velit irure")
json.UpdateInt("macro.restriction.ullamco368",46888012)
http.SetRequestHeader("Content-Type","application/json")
http.SetRequestHeader("Accept","application/json")
# resp is a CkHttpResponse
resp = http.PostJson3("https://example.zendesk.com/api/v2/macros","application/json",json)
if (http.get_LastMethodSuccess() == False):
print(http.lastErrorText())
sys.exit()
sbResponseBody = chilkat.CkStringBuilder()
resp.GetBodySb(sbResponseBody)
jResp = chilkat.CkJsonObject()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(False)
print("Response Body:")
print(jResp.emit())
respStatusCode = resp.get_StatusCode()
print("Response Status Code = " + str(respStatusCode))
if (respStatusCode >= 400):
print("Response Header:")
print(resp.header())
print("Failed.")
sys.exit()
# 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
Title = jResp.stringOf("macro.title")
Active = jResp.stringOf("macro.active")
Created_at = jResp.stringOf("macro.created_at")
Default = jResp.stringOf("macro.default")
Description = jResp.stringOf("macro.description")
Id = jResp.stringOf("macro.id")
Position = jResp.stringOf("macro.position")
Utc = jResp.stringOf("macro.restriction.utc")
Sint_c = jResp.stringOf("macro.restriction.sint_c")
Updated_at = jResp.stringOf("macro.updated_at")
v_Url = jResp.stringOf("macro.url")
App_installation = jResp.stringOf("macro.app_installation")
Categories = jResp.stringOf("macro.categories")
Permissions = jResp.stringOf("macro.permissions")
Usage_1h = jResp.stringOf("macro.usage_1h")
Usage_7d = jResp.stringOf("macro.usage_7d")
Usage_24h = jResp.stringOf("macro.usage_24h")
Usage_30d = jResp.stringOf("macro.usage_30d")
i = 0
count_i = jResp.SizeOfArray("macro.actions")
while i < count_i :
jResp.put_I(i)
field = jResp.stringOf("macro.actions[i].field")
value = jResp.stringOf("macro.actions[i].value")
i = i + 1
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}"
}
]
}
