Foxpro / Support API / Update Macro
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loSbRequestBody
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcField
LOCAL lcValue
LOCAL lcTitle
LOCAL lcActive
LOCAL lcCreated_at
LOCAL lcDefault
LOCAL lcDescription
LOCAL lcId
LOCAL lcPosition
LOCAL lcUtc
LOCAL lcSint_c
LOCAL lcUpdated_at
LOCAL lcV_Url
LOCAL lcApp_installation
LOCAL lcCategories
LOCAL lcPermissions
LOCAL lcUsage_1h
LOCAL lcUsage_7d
LOCAL lcUsage_24h
LOCAL lcUsage_30d
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
loHttp.BasicAuth = 1
loHttp.Login = "login"
loHttp.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
* }
* }
* }
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("macro.title","<string>")
loJson.UpdateString("macro.actions[0].field","<string>")
loJson.UpdateString("macro.actions[0].value","<string>")
loJson.UpdateString("macro.actions[1].field","<string>")
loJson.UpdateString("macro.actions[1].value","<string>")
loJson.UpdateString("macro.active","<boolean>")
loJson.UpdateString("macro.description","<string>")
loJson.UpdateString("macro.restriction.id","<integer>")
loJson.UpdateString("macro.restriction.ids[0]","<integer>")
loJson.UpdateString("macro.restriction.ids[1]","<integer>")
loJson.UpdateString("macro.restriction.type","<string>")
loJson.UpdateString("macro.restriction.dolore_dc","velit irure")
loJson.UpdateInt("macro.restriction.ullamco368",46888012)
loHttp.SetRequestHeader("Content-Type","application/json")
loHttp.SetRequestHeader("Accept","application/json")
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbRequestBody = CreateObject('Chilkat.StringBuilder')
loJson.EmitSb(loSbRequestBody)
loResp = loHttp.PTextSb("PUT","https://example.zendesk.com/api/v2/macros/:macro_id",loSbRequestBody,"utf-8","application/json",0,0)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loJson
RELEASE loSbRequestBody
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loJson
RELEASE loSbRequestBody
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* 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
lcTitle = loJResp.StringOf("macro.title")
lcActive = loJResp.StringOf("macro.active")
lcCreated_at = loJResp.StringOf("macro.created_at")
lcDefault = loJResp.StringOf("macro.default")
lcDescription = loJResp.StringOf("macro.description")
lcId = loJResp.StringOf("macro.id")
lcPosition = loJResp.StringOf("macro.position")
lcUtc = loJResp.StringOf("macro.restriction.utc")
lcSint_c = loJResp.StringOf("macro.restriction.sint_c")
lcUpdated_at = loJResp.StringOf("macro.updated_at")
lcV_Url = loJResp.StringOf("macro.url")
lcApp_installation = loJResp.StringOf("macro.app_installation")
lcCategories = loJResp.StringOf("macro.categories")
lcPermissions = loJResp.StringOf("macro.permissions")
lcUsage_1h = loJResp.StringOf("macro.usage_1h")
lcUsage_7d = loJResp.StringOf("macro.usage_7d")
lcUsage_24h = loJResp.StringOf("macro.usage_24h")
lcUsage_30d = loJResp.StringOf("macro.usage_30d")
i = 0
lnCount_i = loJResp.SizeOfArray("macro.actions")
DO WHILE i < lnCount_i
loJResp.I = i
lcField = loJResp.StringOf("macro.actions[i].field")
lcValue = loJResp.StringOf("macro.actions[i].value")
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loJson
RELEASE loSbRequestBody
RELEASE loSbResponseBody
RELEASE loJResp
Curl Command
curl -u login:password -X PUT
-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/:macro_id
Postman Collection Item JSON
{
"name": "Update Macro",
"request": {
"method": "PUT",
"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/:macro_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"macros",
":macro_id"
],
"variable": [
{
"key": "macro_id",
"value": "<integer>"
}
]
},
"description": "#### Allowed For\n* Agents\n"
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PUT",
"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/:macro_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"macros",
":macro_id"
],
"variable": [
{
"key": "macro_id"
}
]
}
},
"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}"
}
]
}
