Swift / Support API / Create Macro
Back to Collection Items
func chilkatTest() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let http = CkoHttp()
var success: Bool
http.BasicAuth = true
http.Login = "login"
http.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
// }
// }
// }
let json = CkoJsonObject()
json.UpdateString("macro.title", value: "<string>")
json.UpdateString("macro.actions[0].field", value: "<string>")
json.UpdateString("macro.actions[0].value", value: "<string>")
json.UpdateString("macro.actions[1].field", value: "<string>")
json.UpdateString("macro.actions[1].value", value: "<string>")
json.UpdateString("macro.active", value: "<boolean>")
json.UpdateString("macro.description", value: "<string>")
json.UpdateString("macro.restriction.id", value: "<integer>")
json.UpdateString("macro.restriction.ids[0]", value: "<integer>")
json.UpdateString("macro.restriction.ids[1]", value: "<integer>")
json.UpdateString("macro.restriction.type", value: "<string>")
json.UpdateString("macro.restriction.dolore_dc", value: "velit irure")
json.UpdateInt("macro.restriction.ullamco368", value: 46888012)
http.SetRequestHeader("Content-Type", value: "application/json")
http.SetRequestHeader("Accept", value: "application/json")
var resp: CkoHttpResponse? = http.PostJson3("https://example.zendesk.com/api/v2/macros", contentType: "application/json", json: json)
if http.LastMethodSuccess == false {
print("\(http.LastErrorText)")
return
}
let sbResponseBody = CkoStringBuilder()
resp!.GetBodySb(sbResponseBody)
let jResp = CkoJsonObject()
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = false
print("Response Body:")
print("\(jResp.Emit())")
var respStatusCode: Int = resp!.StatusCode.intValue
print("Response Status Code = \(respStatusCode)")
if respStatusCode >= 400 {
print("Response Header:")
print("\(resp!.Header)")
print("Failed.")
resp = nil
return
}
resp = nil
// 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
var field: String?
var value: String?
var Title: String? = jResp.StringOf("macro.title")
var Active: String? = jResp.StringOf("macro.active")
var Created_at: String? = jResp.StringOf("macro.created_at")
var Default: String? = jResp.StringOf("macro.default")
var Description: String? = jResp.StringOf("macro.description")
var Id: String? = jResp.StringOf("macro.id")
var Position: String? = jResp.StringOf("macro.position")
var Utc: String? = jResp.StringOf("macro.restriction.utc")
var Sint_c: String? = jResp.StringOf("macro.restriction.sint_c")
var Updated_at: String? = jResp.StringOf("macro.updated_at")
var v_Url: String? = jResp.StringOf("macro.url")
var App_installation: String? = jResp.StringOf("macro.app_installation")
var Categories: String? = jResp.StringOf("macro.categories")
var Permissions: String? = jResp.StringOf("macro.permissions")
var Usage_1h: String? = jResp.StringOf("macro.usage_1h")
var Usage_7d: String? = jResp.StringOf("macro.usage_7d")
var Usage_24h: String? = jResp.StringOf("macro.usage_24h")
var Usage_30d: String? = jResp.StringOf("macro.usage_30d")
var i: Int = 0
var count_i: Int = jResp.SizeOfArray("macro.actions").intValue
while i < count_i {
jResp.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}"
}
]
}
