Chilkat Online Tools

Objective-C / Support API / Create Organization

Back to Collection Items

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

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

CkoHttpResponse *resp = [http QuickRequest: @"POST" url: @"https://example.zendesk.com/api/v2/organizations"];
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)

// {
//   "organization": {
//     "created_at": "<string>",
//     "details": "<string>",
//     "domain_names": [
//       "<string>",
//       "<string>"
//     ],
//     "external_id": "<string>",
//     "group_id": "<integer>",
//     "id": "<integer>",
//     "name": "<string>",
//     "notes": "<string>",
//     "organization_fields": {
//       "fugiat5_0": "<string>",
//       "exercitation_039": "<string>",
//       "laboris_60": "<string>"
//     },
//     "shared_comments": "<boolean>",
//     "shared_tickets": "<boolean>",
//     "tags": [
//       "<string>",
//       "<string>"
//     ],
//     "updated_at": "<string>",
//     "url": "<string>"
//   }
// }

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

NSString *strVal = 0;

NSString *Created_at = [jResp StringOf: @"organization.created_at"];
NSString *Details = [jResp StringOf: @"organization.details"];
NSString *External_id = [jResp StringOf: @"organization.external_id"];
NSString *Group_id = [jResp StringOf: @"organization.group_id"];
NSString *Id = [jResp StringOf: @"organization.id"];
NSString *Name = [jResp StringOf: @"organization.name"];
NSString *Notes = [jResp StringOf: @"organization.notes"];
NSString *Fugiat5_0 = [jResp StringOf: @"organization.organization_fields.fugiat5_0"];
NSString *Exercitation_039 = [jResp StringOf: @"organization.organization_fields.exercitation_039"];
NSString *Laboris_60 = [jResp StringOf: @"organization.organization_fields.laboris_60"];
NSString *Shared_comments = [jResp StringOf: @"organization.shared_comments"];
NSString *Shared_tickets = [jResp StringOf: @"organization.shared_tickets"];
NSString *Updated_at = [jResp StringOf: @"organization.updated_at"];
NSString *v_Url = [jResp StringOf: @"organization.url"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"organization.domain_names"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: i];
    strVal = [jResp StringOf: @"organization.domain_names[i]"];
    i = i + 1;
}

i = 0;
count_i = [[jResp SizeOfArray: @"organization.tags"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: i];
    strVal = [jResp StringOf: @"organization.tags[i]"];
    i = i + 1;
}

Curl Command

curl  -u login:password -X POST
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/organizations

Postman Collection Item JSON

{
  "name": "Create Organization",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/organizations",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "organizations"
      ]
    },
    "description": "You must provide a unique `name` for each organization. Normally\nthe system doesn't allow records to be created with identical names.\nHowever, a race condition can occur if you make two or more identical\nPOSTs very close to each other, causing the records to have identical\norganization names.\n\n#### Allowed For\n\n* Admins\n* Agents assigned to a custom role with permissions to manage organizations (Enterprise only)\n"
  },
  "response": [
    {
      "name": "Created",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/organizations",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "organizations"
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"organization\": {\n    \"created_at\": \"<string>\",\n    \"details\": \"<string>\",\n    \"domain_names\": [\n      \"<string>\",\n      \"<string>\"\n    ],\n    \"external_id\": \"<string>\",\n    \"group_id\": \"<integer>\",\n    \"id\": \"<integer>\",\n    \"name\": \"<string>\",\n    \"notes\": \"<string>\",\n    \"organization_fields\": {\n      \"fugiat5_0\": \"<string>\",\n      \"exercitation_039\": \"<string>\",\n      \"laboris_60\": \"<string>\"\n    },\n    \"shared_comments\": \"<boolean>\",\n    \"shared_tickets\": \"<boolean>\",\n    \"tags\": [\n      \"<string>\",\n      \"<string>\"\n    ],\n    \"updated_at\": \"<string>\",\n    \"url\": \"<string>\"\n  }\n}"
    }
  ]
}