VB.NET / Support API / Create Macro
Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New Chilkat.Http
Dim success As Boolean
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
' }
' }
' }
Dim json As New Chilkat.JsonObject
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")
Dim resp As Chilkat.HttpResponse = http.PostJson3("https://example.zendesk.com/api/v2/macros","application/json",json)
If (http.LastMethodSuccess = False) Then
Debug.WriteLine(http.LastErrorText)
Exit Sub
End If
Dim sbResponseBody As New Chilkat.StringBuilder
resp.GetBodySb(sbResponseBody)
Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())
Dim respStatusCode As Integer = resp.StatusCode
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
Debug.WriteLine("Response Header:")
Debug.WriteLine(resp.Header)
Debug.WriteLine("Failed.")
Exit Sub
End If
' 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
Dim field As String
Dim value As String
Dim Title As String = jResp.StringOf("macro.title")
Dim Active As String = jResp.StringOf("macro.active")
Dim Created_at As String = jResp.StringOf("macro.created_at")
Dim Default As String = jResp.StringOf("macro.default")
Dim Description As String = jResp.StringOf("macro.description")
Dim Id As String = jResp.StringOf("macro.id")
Dim Position As String = jResp.StringOf("macro.position")
Dim Utc As String = jResp.StringOf("macro.restriction.utc")
Dim Sint_c As String = jResp.StringOf("macro.restriction.sint_c")
Dim Updated_at As String = jResp.StringOf("macro.updated_at")
Dim v_Url As String = jResp.StringOf("macro.url")
Dim App_installation As String = jResp.StringOf("macro.app_installation")
Dim Categories As String = jResp.StringOf("macro.categories")
Dim Permissions As String = jResp.StringOf("macro.permissions")
Dim Usage_1h As String = jResp.StringOf("macro.usage_1h")
Dim Usage_7d As String = jResp.StringOf("macro.usage_7d")
Dim Usage_24h As String = jResp.StringOf("macro.usage_24h")
Dim Usage_30d As String = jResp.StringOf("macro.usage_30d")
Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("macro.actions")
While i < count_i
jResp.I = i
field = jResp.StringOf("macro.actions[i].field")
value = jResp.StringOf("macro.actions[i].value")
i = i + 1
End While
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}"
}
]
}
