unicodeCpp / Support API / Create User
Back to Collection Items
#include <CkHttpW.h>
#include <CkJsonObjectW.h>
#include <CkHttpResponseW.h>
#include <CkStringBuilderW.h>
void ChilkatSample(void)
{
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkHttpW http;
bool success;
http.put_BasicAuth(true);
http.put_Login(L"login");
http.put_Password(L"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>"
// }
// }
CkJsonObjectW json;
json.UpdateString(L"user.name",L"<string>");
json.UpdateString(L"user.email",L"<string>");
json.UpdateString(L"user.custom_role_id",L"<integer>");
json.UpdateString(L"user.external_id",L"<string>");
json.UpdateString(L"user.identities[0].type",L"<string>");
json.UpdateString(L"user.identities[0].value",L"<string>");
json.UpdateString(L"user.identities[1].type",L"<string>");
json.UpdateString(L"user.identities[1].value",L"<string>");
json.UpdateString(L"user.organization.name",L"<string>");
json.UpdateString(L"user.organization_id",L"<integer>");
json.UpdateString(L"user.role",L"<string>");
http.SetRequestHeader(L"Content-Type",L"application/json");
http.SetRequestHeader(L"Accept",L"application/json");
CkHttpResponseW *resp = http.PostJson3(L"https://example.zendesk.com/api/v2/users",L"application/json",json);
if (http.get_LastMethodSuccess() == false) {
wprintf(L"%s\n",http.lastErrorText());
return;
}
CkStringBuilderW sbResponseBody;
resp->GetBodySb(sbResponseBody);
CkJsonObjectW jResp;
jResp.LoadSb(sbResponseBody);
jResp.put_EmitCompact(false);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",jResp.emit());
int respStatusCode = resp->get_StatusCode();
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",resp->header());
wprintf(L"Failed.\n");
delete resp;
return;
}
delete 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.
const wchar_t *Name = jResp.stringOf(L"user.name");
const wchar_t *Active = jResp.stringOf(L"user.active");
const wchar_t *Alias = jResp.stringOf(L"user.alias");
const wchar_t *Chat_only = jResp.stringOf(L"user.chat_only");
const wchar_t *Created_at = jResp.stringOf(L"user.created_at");
const wchar_t *Custom_role_id = jResp.stringOf(L"user.custom_role_id");
const wchar_t *Default_group_id = jResp.stringOf(L"user.default_group_id");
const wchar_t *Details = jResp.stringOf(L"user.details");
const wchar_t *v_Email = jResp.stringOf(L"user.email");
const wchar_t *External_id = jResp.stringOf(L"user.external_id");
const wchar_t *Iana_time_zone = jResp.stringOf(L"user.iana_time_zone");
const wchar_t *Id = jResp.stringOf(L"user.id");
const wchar_t *Last_login_at = jResp.stringOf(L"user.last_login_at");
const wchar_t *Locale = jResp.stringOf(L"user.locale");
const wchar_t *Locale_id = jResp.stringOf(L"user.locale_id");
const wchar_t *Moderator = jResp.stringOf(L"user.moderator");
const wchar_t *Notes = jResp.stringOf(L"user.notes");
const wchar_t *Only_private_comments = jResp.stringOf(L"user.only_private_comments");
const wchar_t *Organization_id = jResp.stringOf(L"user.organization_id");
const wchar_t *Phone = jResp.stringOf(L"user.phone");
bool Dolorea1 = jResp.BoolOf(L"user.photo.dolorea1");
const wchar_t *Deserunt3 = jResp.stringOf(L"user.photo.deserunt3");
const wchar_t *Remote_photo_url = jResp.stringOf(L"user.remote_photo_url");
const wchar_t *Report_csv = jResp.stringOf(L"user.report_csv");
const wchar_t *Restricted_agent = jResp.stringOf(L"user.restricted_agent");
const wchar_t *Role = jResp.stringOf(L"user.role");
const wchar_t *Role_type = jResp.stringOf(L"user.role_type");
const wchar_t *v_Shared = jResp.stringOf(L"user.shared");
const wchar_t *Shared_agent = jResp.stringOf(L"user.shared_agent");
const wchar_t *Shared_phone_number = jResp.stringOf(L"user.shared_phone_number");
const wchar_t *Signature = jResp.stringOf(L"user.signature");
const wchar_t *Suspended = jResp.stringOf(L"user.suspended");
const wchar_t *Tags = jResp.stringOf(L"user.tags");
const wchar_t *Ticket_restriction = jResp.stringOf(L"user.ticket_restriction");
const wchar_t *Time_zone = jResp.stringOf(L"user.time_zone");
const wchar_t *Two_factor_auth_enabled = jResp.stringOf(L"user.two_factor_auth_enabled");
const wchar_t *Updated_at = jResp.stringOf(L"user.updated_at");
const wchar_t *v_Url = jResp.stringOf(L"user.url");
const wchar_t *Nostrudacc = jResp.stringOf(L"user.user_fields.nostrudacc");
const wchar_t *In_80e = jResp.stringOf(L"user.user_fields.in_80e");
bool Proident_e2 = jResp.BoolOf(L"user.user_fields.proident_e2");
int Voluptate_98 = jResp.IntOf(L"user.user_fields.voluptate_98");
const wchar_t *Verified = jResp.stringOf(L"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}"
}
]
}
