Node.js / Support API / Create Or Update User
Back to Collection Items
var os = require('os');
if (os.platform() == 'win32') {
if (os.arch() == 'ia32') {
var chilkat = require('@chilkat/ck-node21-win-ia32');
} else {
var chilkat = require('@chilkat/ck-node21-win64');
}
} else if (os.platform() == 'linux') {
if (os.arch() == 'arm') {
var chilkat = require('@chilkat/ck-node21-arm');
} else if (os.arch() == 'x86') {
var chilkat = require('@chilkat/ck-node21-linux32');
} else {
var chilkat = require('@chilkat/ck-node21-linux64');
}
} else if (os.platform() == 'darwin') {
if (os.arch() == 'arm64') {
var chilkat = require('@chilkat/ck-node21-mac-m1');
} else {
var chilkat = require('@chilkat/ck-node21-macosx');
}
}
function chilkatExample() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
var http = new chilkat.Http();
var success;
http.BasicAuth = true;
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>"
// }
// }
var json = new chilkat.JsonObject();
json.UpdateString("user.name","<string>");
json.UpdateString("user.email","<string>");
json.UpdateString("user.custom_role_id","<integer>");
json.UpdateString("user.external_id","<string>");
json.UpdateString("user.identities[0].type","<string>");
json.UpdateString("user.identities[0].value","<string>");
json.UpdateString("user.identities[1].type","<string>");
json.UpdateString("user.identities[1].value","<string>");
json.UpdateString("user.organization.name","<string>");
json.UpdateString("user.organization_id","<integer>");
json.UpdateString("user.role","<string>");
http.SetRequestHeader("Content-Type","application/json");
http.SetRequestHeader("Accept","application/json");
// resp: HttpResponse
var resp = http.PostJson3("https://example.zendesk.com/api/v2/users/create_or_update","application/json",json);
if (http.LastMethodSuccess == false) {
console.log(http.LastErrorText);
return;
}
var sbResponseBody = new chilkat.StringBuilder();
resp.GetBodySb(sbResponseBody);
var jResp = new chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;
console.log("Response Body:");
console.log(jResp.Emit());
var respStatusCode = resp.StatusCode;
console.log("Response Status Code = " + respStatusCode);
if (respStatusCode >= 400) {
console.log("Response Header:");
console.log(resp.Header);
console.log("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
var Name = jResp.StringOf("user.name");
var Active = jResp.StringOf("user.active");
var Alias = jResp.StringOf("user.alias");
var Chat_only = jResp.StringOf("user.chat_only");
var Created_at = jResp.StringOf("user.created_at");
var Custom_role_id = jResp.StringOf("user.custom_role_id");
var Default_group_id = jResp.StringOf("user.default_group_id");
var Details = jResp.StringOf("user.details");
var v_Email = jResp.StringOf("user.email");
var External_id = jResp.StringOf("user.external_id");
var Iana_time_zone = jResp.StringOf("user.iana_time_zone");
var Id = jResp.StringOf("user.id");
var Last_login_at = jResp.StringOf("user.last_login_at");
var Locale = jResp.StringOf("user.locale");
var Locale_id = jResp.StringOf("user.locale_id");
var Moderator = jResp.StringOf("user.moderator");
var Notes = jResp.StringOf("user.notes");
var Only_private_comments = jResp.StringOf("user.only_private_comments");
var Organization_id = jResp.StringOf("user.organization_id");
var Phone = jResp.StringOf("user.phone");
var Dolorea1 = jResp.BoolOf("user.photo.dolorea1");
var Deserunt3 = jResp.StringOf("user.photo.deserunt3");
var Remote_photo_url = jResp.StringOf("user.remote_photo_url");
var Report_csv = jResp.StringOf("user.report_csv");
var Restricted_agent = jResp.StringOf("user.restricted_agent");
var Role = jResp.StringOf("user.role");
var Role_type = jResp.StringOf("user.role_type");
var v_Shared = jResp.StringOf("user.shared");
var Shared_agent = jResp.StringOf("user.shared_agent");
var Shared_phone_number = jResp.StringOf("user.shared_phone_number");
var Signature = jResp.StringOf("user.signature");
var Suspended = jResp.StringOf("user.suspended");
var Tags = jResp.StringOf("user.tags");
var Ticket_restriction = jResp.StringOf("user.ticket_restriction");
var Time_zone = jResp.StringOf("user.time_zone");
var Two_factor_auth_enabled = jResp.StringOf("user.two_factor_auth_enabled");
var Updated_at = jResp.StringOf("user.updated_at");
var v_Url = jResp.StringOf("user.url");
var Nostrudacc = jResp.StringOf("user.user_fields.nostrudacc");
var In_80e = jResp.StringOf("user.user_fields.in_80e");
var Proident_e2 = jResp.BoolOf("user.user_fields.proident_e2");
var Voluptate_98 = jResp.IntOf("user.user_fields.voluptate_98");
var Verified = jResp.StringOf("user.verified");
}
chilkatExample();
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/create_or_update
Postman Collection Item JSON
{
"name": "Create Or Update 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/create_or_update",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
"create_or_update"
]
},
"description": "Creates a user if the user does not already exist, or updates an existing user\nidentified by e-mail address or external ID.\n\nIf you don't specify a role parameter, the new user is assigned the role of end user.\n\nIf you need to create users without sending out a verification email, include a `\"skip_verify_email\": true` property in the body.\n\n#### Response Status Code\n\n- If the user exists in Zendesk, a successful request returns a 200 status code with \"Location: /api/v2/users/{user_id}.json\".\n- If the user does not exist in Zendesk, a successful request returns a 201 status code with \"Location: /api/v2/users/{new_user_id}.json\".\n\n#### Rate Limit\n\nThe rate limit is 5 requests per minute for each unique end user profile. For example, you can make 10 calls per second as long as you make five calls for one user and five calls for another user.\nThe rate limiting mechanism behaves as described in\n[Usage Limits](/api-reference/introduction/rate-limits/#monitoring-your-request-activity)\nin the API introduction. Zendesk recommends that you obey the Retry-After header values.\n\n#### Allowed For\n\n* Agents, with restrictions on certain actions\n"
},
"response": [
{
"name": "Successful response, when user exits",
"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/create_or_update",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
"create_or_update"
]
}
},
"status": "OK",
"code": 200,
"_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}"
},
{
"name": "Created response, when user is new",
"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/create_or_update",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
"create_or_update"
]
}
},
"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}"
}
]
}
