Chilkat Online Tools

Objective-C / Support API / Create Custom Ticket Status

Back to Collection Items

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.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.

// {
//   "custom_status": {
//     "active": "<boolean>",
//     "agent_label": "<string>",
//     "description": "<string>",
//     "end_user_description": "<string>",
//     "end_user_label": "<string>",
//     "status_category": "new"
//   }
// }

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"custom_status.active" value: @"<boolean>"];
[json UpdateString: @"custom_status.agent_label" value: @"<string>"];
[json UpdateString: @"custom_status.description" value: @"<string>"];
[json UpdateString: @"custom_status.end_user_description" value: @"<string>"];
[json UpdateString: @"custom_status.end_user_label" value: @"<string>"];
[json UpdateString: @"custom_status.status_category" value: @"new"];

[http SetRequestHeader: @"Content-Type" value: @"application/json"];
[http SetRequestHeader: @"Accept" value: @"application/json"];

CkoHttpResponse *resp = [http PostJson3: @"https://example.zendesk.com/api/v2/custom_statuses" contentType: @"application/json" json: json];
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)

// {
//   "custom_status": {
//     "status_category": "open",
//     "agent_label": "<string>",
//     "active": "<boolean>",
//     "created_at": "<dateTime>",
//     "default": "<boolean>",
//     "description": "<string>",
//     "end_user_description": "<string>",
//     "end_user_label": "<string>",
//     "id": "<integer>",
//     "raw_agent_label": "<string>",
//     "raw_description": "<string>",
//     "raw_end_user_description": "<string>",
//     "raw_end_user_label": "<string>",
//     "updated_at": "<dateTime>"
//   }
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

NSString *Status_category = [jResp StringOf: @"custom_status.status_category"];
NSString *Agent_label = [jResp StringOf: @"custom_status.agent_label"];
NSString *Active = [jResp StringOf: @"custom_status.active"];
NSString *Created_at = [jResp StringOf: @"custom_status.created_at"];
NSString *Default = [jResp StringOf: @"custom_status.default"];
NSString *Description = [jResp StringOf: @"custom_status.description"];
NSString *End_user_description = [jResp StringOf: @"custom_status.end_user_description"];
NSString *End_user_label = [jResp StringOf: @"custom_status.end_user_label"];
NSString *Id = [jResp StringOf: @"custom_status.id"];
NSString *Raw_agent_label = [jResp StringOf: @"custom_status.raw_agent_label"];
NSString *Raw_description = [jResp StringOf: @"custom_status.raw_description"];
NSString *Raw_end_user_description = [jResp StringOf: @"custom_status.raw_end_user_description"];
NSString *Raw_end_user_label = [jResp StringOf: @"custom_status.raw_end_user_label"];
NSString *Updated_at = [jResp StringOf: @"custom_status.updated_at"];

Curl Command

curl  -u login:password -X POST
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "custom_status": {
    "active": "<boolean>",
    "agent_label": "<string>",
    "description": "<string>",
    "end_user_description": "<string>",
    "end_user_label": "<string>",
    "status_category": "new"
  }
}'
https://example.zendesk.com/api/v2/custom_statuses

Postman Collection Item JSON

{
  "name": "Create Custom Ticket Status",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"custom_status\": {\n    \"active\": \"<boolean>\",\n    \"agent_label\": \"<string>\",\n    \"description\": \"<string>\",\n    \"end_user_description\": \"<string>\",\n    \"end_user_label\": \"<string>\",\n    \"status_category\": \"new\"\n  }\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/api/v2/custom_statuses",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "custom_statuses"
      ]
    },
    "description": "Takes a `custom_status` object that specifies the custom ticket status properties to create.\n\n#### Allowed For\n\n* Admins\n"
  },
  "response": [
    {
      "name": "Created",
      "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  \"custom_status\": {\n    \"active\": \"<boolean>\",\n    \"agent_label\": \"<string>\",\n    \"description\": \"<string>\",\n    \"end_user_description\": \"<string>\",\n    \"end_user_label\": \"<string>\",\n    \"status_category\": \"new\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/custom_statuses",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "custom_statuses"
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"custom_status\": {\n    \"status_category\": \"open\",\n    \"agent_label\": \"<string>\",\n    \"active\": \"<boolean>\",\n    \"created_at\": \"<dateTime>\",\n    \"default\": \"<boolean>\",\n    \"description\": \"<string>\",\n    \"end_user_description\": \"<string>\",\n    \"end_user_label\": \"<string>\",\n    \"id\": \"<integer>\",\n    \"raw_agent_label\": \"<string>\",\n    \"raw_description\": \"<string>\",\n    \"raw_end_user_description\": \"<string>\",\n    \"raw_end_user_label\": \"<string>\",\n    \"updated_at\": \"<dateTime>\"\n  }\n}"
    }
  ]
}