Chilkat Online Tools

C / Support API / Create User

Back to Collection Items

#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkHttpResponse.h>
#include <C_CkStringBuilder.h>

void ChilkatSample(void)
    {
    HCkHttp http;
    BOOL success;
    HCkJsonObject json;
    HCkHttpResponse resp;
    HCkStringBuilder sbResponseBody;
    HCkJsonObject jResp;
    int respStatusCode;
    const char *Name;
    const char *Active;
    const char *Alias;
    const char *Chat_only;
    const char *Created_at;
    const char *Custom_role_id;
    const char *Default_group_id;
    const char *Details;
    const char *v_Email;
    const char *External_id;
    const char *Iana_time_zone;
    const char *Id;
    const char *Last_login_at;
    const char *Locale;
    const char *Locale_id;
    const char *Moderator;
    const char *Notes;
    const char *Only_private_comments;
    const char *Organization_id;
    const char *Phone;
    BOOL Dolorea1;
    const char *Deserunt3;
    const char *Remote_photo_url;
    const char *Report_csv;
    const char *Restricted_agent;
    const char *Role;
    const char *Role_type;
    const char *v_Shared;
    const char *Shared_agent;
    const char *Shared_phone_number;
    const char *Signature;
    const char *Suspended;
    const char *Tags;
    const char *Ticket_restriction;
    const char *Time_zone;
    const char *Two_factor_auth_enabled;
    const char *Updated_at;
    const char *v_Url;
    const char *Nostrudacc;
    const char *In_80e;
    BOOL Proident_e2;
    int Voluptate_98;
    const char *Verified;

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    http = CkHttp_Create();

    CkHttp_putBasicAuth(http,TRUE);
    CkHttp_putLogin(http,"login");
    CkHttp_putPassword(http,"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>"
    //   }
    // }

    json = CkJsonObject_Create();
    CkJsonObject_UpdateString(json,"user.name","<string>");
    CkJsonObject_UpdateString(json,"user.email","<string>");
    CkJsonObject_UpdateString(json,"user.custom_role_id","<integer>");
    CkJsonObject_UpdateString(json,"user.external_id","<string>");
    CkJsonObject_UpdateString(json,"user.identities[0].type","<string>");
    CkJsonObject_UpdateString(json,"user.identities[0].value","<string>");
    CkJsonObject_UpdateString(json,"user.identities[1].type","<string>");
    CkJsonObject_UpdateString(json,"user.identities[1].value","<string>");
    CkJsonObject_UpdateString(json,"user.organization.name","<string>");
    CkJsonObject_UpdateString(json,"user.organization_id","<integer>");
    CkJsonObject_UpdateString(json,"user.role","<string>");

    CkHttp_SetRequestHeader(http,"Content-Type","application/json");
    CkHttp_SetRequestHeader(http,"Accept","application/json");

    resp = CkHttp_PostJson3(http,"https://example.zendesk.com/api/v2/users","application/json",json);
    if (CkHttp_getLastMethodSuccess(http) == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(json);
        return;
    }

    sbResponseBody = CkStringBuilder_Create();
    CkHttpResponse_GetBodySb(resp,sbResponseBody);

    jResp = CkJsonObject_Create();
    CkJsonObject_LoadSb(jResp,sbResponseBody);
    CkJsonObject_putEmitCompact(jResp,FALSE);

    printf("Response Body:\n");
    printf("%s\n",CkJsonObject_emit(jResp));

    respStatusCode = CkHttpResponse_getStatusCode(resp);
    printf("Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        printf("Response Header:\n");
        printf("%s\n",CkHttpResponse_header(resp));
        printf("Failed.\n");
        CkHttpResponse_Dispose(resp);
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(json);
        CkStringBuilder_Dispose(sbResponseBody);
        CkJsonObject_Dispose(jResp);
        return;
    }

    CkHttpResponse_Dispose(resp);

    // 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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

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


    CkHttp_Dispose(http);
    CkJsonObject_Dispose(json);
    CkStringBuilder_Dispose(sbResponseBody);
    CkJsonObject_Dispose(jResp);

    }

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}"
    }
  ]
}