Chilkat Online Tools

Objective-C / Support API / Create User

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.

// {
//   "user": {
//     "name": "<string>",
//     "email": "<string>",
//     "custom_role_id": "<integer>",
//     "external_id": "<string>",
//     "identities": [
//       {
//         "type": "<string>",
//         "value": "<string>"
//       },
//       {
//         "type": "<string>",
//         "value": "<string>"
//       }
//     ],
//     "organization": {
//       "name": "<string>"
//     },
//     "organization_id": "<integer>",
//     "role": "<string>"
//   }
// }

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"user.name" value: @"<string>"];
[json UpdateString: @"user.email" value: @"<string>"];
[json UpdateString: @"user.custom_role_id" value: @"<integer>"];
[json UpdateString: @"user.external_id" value: @"<string>"];
[json UpdateString: @"user.identities[0].type" value: @"<string>"];
[json UpdateString: @"user.identities[0].value" value: @"<string>"];
[json UpdateString: @"user.identities[1].type" value: @"<string>"];
[json UpdateString: @"user.identities[1].value" value: @"<string>"];
[json UpdateString: @"user.organization.name" value: @"<string>"];
[json UpdateString: @"user.organization_id" value: @"<integer>"];
[json UpdateString: @"user.role" value: @"<string>"];

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

CkoHttpResponse *resp = [http PostJson3: @"https://example.zendesk.com/api/v2/users" 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)

// {
//   "user": {
//     "name": "<string>",
//     "active": "<boolean>",
//     "alias": "<string>",
//     "chat_only": "<boolean>",
//     "created_at": "<string>",
//     "custom_role_id": "<integer>",
//     "default_group_id": "<integer>",
//     "details": "<string>",
//     "email": "<string>",
//     "external_id": "<string>",
//     "iana_time_zone": "<string>",
//     "id": "<integer>",
//     "last_login_at": "<string>",
//     "locale": "<string>",
//     "locale_id": "<integer>",
//     "moderator": "<boolean>",
//     "notes": "<string>",
//     "only_private_comments": "<boolean>",
//     "organization_id": "<integer>",
//     "phone": "<string>",
//     "photo": {
//       "dolorea1": false,
//       "deserunt3": 95124319.10825741
//     },
//     "remote_photo_url": "<string>",
//     "report_csv": "<boolean>",
//     "restricted_agent": "<boolean>",
//     "role": "<string>",
//     "role_type": "<integer>",
//     "shared": "<boolean>",
//     "shared_agent": "<boolean>",
//     "shared_phone_number": "<boolean>",
//     "signature": "<string>",
//     "suspended": "<boolean>",
//     "tags": "<array>",
//     "ticket_restriction": "<string>",
//     "time_zone": "<string>",
//     "two_factor_auth_enabled": "<boolean>",
//     "updated_at": "<string>",
//     "url": "<string>",
//     "user_fields": {
//       "nostrudacc": -12929960.546221554,
//       "in_80e": 25167751.960886702,
//       "proident_e2": true,
//       "voluptate_98": -58995022
//     },
//     "verified": "<boolean>"
//   }
// }

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

NSString *Name = [jResp StringOf: @"user.name"];
NSString *Active = [jResp StringOf: @"user.active"];
NSString *Alias = [jResp StringOf: @"user.alias"];
NSString *Chat_only = [jResp StringOf: @"user.chat_only"];
NSString *Created_at = [jResp StringOf: @"user.created_at"];
NSString *Custom_role_id = [jResp StringOf: @"user.custom_role_id"];
NSString *Default_group_id = [jResp StringOf: @"user.default_group_id"];
NSString *Details = [jResp StringOf: @"user.details"];
NSString *v_Email = [jResp StringOf: @"user.email"];
NSString *External_id = [jResp StringOf: @"user.external_id"];
NSString *Iana_time_zone = [jResp StringOf: @"user.iana_time_zone"];
NSString *Id = [jResp StringOf: @"user.id"];
NSString *Last_login_at = [jResp StringOf: @"user.last_login_at"];
NSString *Locale = [jResp StringOf: @"user.locale"];
NSString *Locale_id = [jResp StringOf: @"user.locale_id"];
NSString *Moderator = [jResp StringOf: @"user.moderator"];
NSString *Notes = [jResp StringOf: @"user.notes"];
NSString *Only_private_comments = [jResp StringOf: @"user.only_private_comments"];
NSString *Organization_id = [jResp StringOf: @"user.organization_id"];
NSString *Phone = [jResp StringOf: @"user.phone"];
BOOL Dolorea1 = [jResp BoolOf: @"user.photo.dolorea1"];
NSString *Deserunt3 = [jResp StringOf: @"user.photo.deserunt3"];
NSString *Remote_photo_url = [jResp StringOf: @"user.remote_photo_url"];
NSString *Report_csv = [jResp StringOf: @"user.report_csv"];
NSString *Restricted_agent = [jResp StringOf: @"user.restricted_agent"];
NSString *Role = [jResp StringOf: @"user.role"];
NSString *Role_type = [jResp StringOf: @"user.role_type"];
NSString *v_Shared = [jResp StringOf: @"user.shared"];
NSString *Shared_agent = [jResp StringOf: @"user.shared_agent"];
NSString *Shared_phone_number = [jResp StringOf: @"user.shared_phone_number"];
NSString *Signature = [jResp StringOf: @"user.signature"];
NSString *Suspended = [jResp StringOf: @"user.suspended"];
NSString *Tags = [jResp StringOf: @"user.tags"];
NSString *Ticket_restriction = [jResp StringOf: @"user.ticket_restriction"];
NSString *Time_zone = [jResp StringOf: @"user.time_zone"];
NSString *Two_factor_auth_enabled = [jResp StringOf: @"user.two_factor_auth_enabled"];
NSString *Updated_at = [jResp StringOf: @"user.updated_at"];
NSString *v_Url = [jResp StringOf: @"user.url"];
NSString *Nostrudacc = [jResp StringOf: @"user.user_fields.nostrudacc"];
NSString *In_80e = [jResp StringOf: @"user.user_fields.in_80e"];
BOOL Proident_e2 = [jResp BoolOf: @"user.user_fields.proident_e2"];
int Voluptate_98 = [[jResp IntOf: @"user.user_fields.voluptate_98"] intValue];
NSString *Verified = [jResp StringOf: @"user.verified"];

Curl Command

curl  -u login:password -X POST
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "user": {
    "name": "<string>",
    "email": "<string>",
    "custom_role_id": "<integer>",
    "external_id": "<string>",
    "identities": [
      {
        "type": "<string>",
        "value": "<string>"
      },
      {
        "type": "<string>",
        "value": "<string>"
      }
    ],
    "organization": {
      "name": "<string>"
    },
    "organization_id": "<integer>",
    "role": "<string>"
  }
}'
https://example.zendesk.com/api/v2/users

Postman Collection Item JSON

{
  "name": "Create User",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"user\": {\n    \"name\": \"<string>\",\n    \"email\": \"<string>\",\n    \"custom_role_id\": \"<integer>\",\n    \"external_id\": \"<string>\",\n    \"identities\": [\n      {\n        \"type\": \"<string>\",\n        \"value\": \"<string>\"\n      },\n      {\n        \"type\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"organization\": {\n      \"name\": \"<string>\"\n    },\n    \"organization_id\": \"<integer>\",\n    \"role\": \"<string>\"\n  }\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/api/v2/users",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "users"
      ]
    }
  },
  "response": [
    {
      "name": "Created response",
      "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  \"user\": {\n    \"name\": \"<string>\",\n    \"email\": \"<string>\",\n    \"custom_role_id\": \"<integer>\",\n    \"external_id\": \"<string>\",\n    \"identities\": [\n      {\n        \"type\": \"<string>\",\n        \"value\": \"<string>\"\n      },\n      {\n        \"type\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"organization\": {\n      \"name\": \"<string>\"\n    },\n    \"organization_id\": \"<integer>\",\n    \"role\": \"<string>\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/users",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "users"
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"user\": {\n    \"name\": \"<string>\",\n    \"active\": \"<boolean>\",\n    \"alias\": \"<string>\",\n    \"chat_only\": \"<boolean>\",\n    \"created_at\": \"<string>\",\n    \"custom_role_id\": \"<integer>\",\n    \"default_group_id\": \"<integer>\",\n    \"details\": \"<string>\",\n    \"email\": \"<string>\",\n    \"external_id\": \"<string>\",\n    \"iana_time_zone\": \"<string>\",\n    \"id\": \"<integer>\",\n    \"last_login_at\": \"<string>\",\n    \"locale\": \"<string>\",\n    \"locale_id\": \"<integer>\",\n    \"moderator\": \"<boolean>\",\n    \"notes\": \"<string>\",\n    \"only_private_comments\": \"<boolean>\",\n    \"organization_id\": \"<integer>\",\n    \"phone\": \"<string>\",\n    \"photo\": {\n      \"dolorea1\": false,\n      \"deserunt3\": 95124319.10825741\n    },\n    \"remote_photo_url\": \"<string>\",\n    \"report_csv\": \"<boolean>\",\n    \"restricted_agent\": \"<boolean>\",\n    \"role\": \"<string>\",\n    \"role_type\": \"<integer>\",\n    \"shared\": \"<boolean>\",\n    \"shared_agent\": \"<boolean>\",\n    \"shared_phone_number\": \"<boolean>\",\n    \"signature\": \"<string>\",\n    \"suspended\": \"<boolean>\",\n    \"tags\": \"<array>\",\n    \"ticket_restriction\": \"<string>\",\n    \"time_zone\": \"<string>\",\n    \"two_factor_auth_enabled\": \"<boolean>\",\n    \"updated_at\": \"<string>\",\n    \"url\": \"<string>\",\n    \"user_fields\": {\n      \"nostrudacc\": -12929960.546221554,\n      \"in_80e\": 25167751.960886702,\n      \"proident_e2\": true,\n      \"voluptate_98\": -58995022\n    },\n    \"verified\": \"<boolean>\"\n  }\n}"
    }
  ]
}