Objective-C / Support API / Update Macro
Back to Collection Items
#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoStringBuilder.h>
#import <CkoHttpResponse.h>
#import <NSString.h>
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;
http.BasicAuth = YES;
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
// }
// }
// }
CkoJsonObject *json = [[CkoJsonObject alloc] init];
[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: [NSNumber numberWithInt: 46888012]];
[http SetRequestHeader: @"Content-Type" value: @"application/json"];
[http SetRequestHeader: @"Accept" value: @"application/json"];
CkoStringBuilder *sbRequestBody = [[CkoStringBuilder alloc] init];
[json EmitSb: sbRequestBody];
CkoHttpResponse *resp = [http PTextSb: @"PUT" url: @"https://example.zendesk.com/api/v2/macros/:macro_id" textData: sbRequestBody charset: @"utf-8" contentType: @"application/json" md5: NO gzip: NO];
if (http.LastMethodSuccess == NO) {
NSLog(@"%@",http.LastErrorText);
return;
}
CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];
CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;
NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);
int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
NSLog(@"%@",@"Response Header:");
NSLog(@"%@",resp.Header);
NSLog(@"%@",@"Failed.");
return;
}
// 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
NSString *field = 0;
NSString *value = 0;
NSString *Title = [jResp StringOf: @"macro.title"];
NSString *Active = [jResp StringOf: @"macro.active"];
NSString *Created_at = [jResp StringOf: @"macro.created_at"];
NSString *Default = [jResp StringOf: @"macro.default"];
NSString *Description = [jResp StringOf: @"macro.description"];
NSString *Id = [jResp StringOf: @"macro.id"];
NSString *Position = [jResp StringOf: @"macro.position"];
NSString *Utc = [jResp StringOf: @"macro.restriction.utc"];
NSString *Sint_c = [jResp StringOf: @"macro.restriction.sint_c"];
NSString *Updated_at = [jResp StringOf: @"macro.updated_at"];
NSString *v_Url = [jResp StringOf: @"macro.url"];
NSString *App_installation = [jResp StringOf: @"macro.app_installation"];
NSString *Categories = [jResp StringOf: @"macro.categories"];
NSString *Permissions = [jResp StringOf: @"macro.permissions"];
NSString *Usage_1h = [jResp StringOf: @"macro.usage_1h"];
NSString *Usage_7d = [jResp StringOf: @"macro.usage_7d"];
NSString *Usage_24h = [jResp StringOf: @"macro.usage_24h"];
NSString *Usage_30d = [jResp StringOf: @"macro.usage_30d"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"macro.actions"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: 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 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}"
}
]
}
