TCL / Support API / Create Many Users
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "login"
CkHttp_put_Password $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.
# {
# "users": [
# {
# "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>"
# },
# {
# "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>"
# }
# ]
# }
set json [new_CkJsonObject]
CkJsonObject_UpdateString $json "users[0].name" "<string>"
CkJsonObject_UpdateString $json "users[0].email" "<string>"
CkJsonObject_UpdateString $json "users[0].custom_role_id" "<integer>"
CkJsonObject_UpdateString $json "users[0].external_id" "<string>"
CkJsonObject_UpdateString $json "users[0].identities[0].type" "<string>"
CkJsonObject_UpdateString $json "users[0].identities[0].value" "<string>"
CkJsonObject_UpdateString $json "users[0].identities[1].type" "<string>"
CkJsonObject_UpdateString $json "users[0].identities[1].value" "<string>"
CkJsonObject_UpdateString $json "users[0].organization.name" "<string>"
CkJsonObject_UpdateString $json "users[0].organization_id" "<integer>"
CkJsonObject_UpdateString $json "users[0].role" "<string>"
CkJsonObject_UpdateString $json "users[1].name" "<string>"
CkJsonObject_UpdateString $json "users[1].email" "<string>"
CkJsonObject_UpdateString $json "users[1].custom_role_id" "<integer>"
CkJsonObject_UpdateString $json "users[1].external_id" "<string>"
CkJsonObject_UpdateString $json "users[1].identities[0].type" "<string>"
CkJsonObject_UpdateString $json "users[1].identities[0].value" "<string>"
CkJsonObject_UpdateString $json "users[1].identities[1].type" "<string>"
CkJsonObject_UpdateString $json "users[1].identities[1].value" "<string>"
CkJsonObject_UpdateString $json "users[1].organization.name" "<string>"
CkJsonObject_UpdateString $json "users[1].organization_id" "<integer>"
CkJsonObject_UpdateString $json "users[1].role" "<string>"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"
CkHttp_SetRequestHeader $http "Accept" "application/json"
# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://example.zendesk.com/api/v2/users/create_many" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $json
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "job_status": {
# "id": "<string>",
# "message": "<string>",
# "progress": "<integer>",
# "results": [
# {
# "id": "<integer>",
# "index": "<integer>"
# },
# {
# "id": "<integer>",
# "index": "<integer>"
# }
# ],
# "status": "<string>",
# "total": "<integer>",
# "url": "<string>"
# }
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set Id [CkJsonObject_stringOf $jResp "job_status.id"]
set Message [CkJsonObject_stringOf $jResp "job_status.message"]
set Progress [CkJsonObject_stringOf $jResp "job_status.progress"]
set Status [CkJsonObject_stringOf $jResp "job_status.status"]
set Total [CkJsonObject_stringOf $jResp "job_status.total"]
set v_Url [CkJsonObject_stringOf $jResp "job_status.url"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "job_status.results"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set id [CkJsonObject_stringOf $jResp "job_status.results[i].id"]
set index [CkJsonObject_stringOf $jResp "job_status.results[i].index"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -u login:password -X POST
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"users": [
{
"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>"
},
{
"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_many
Postman Collection Item JSON
{
"name": "Create Many Users",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"users\": [\n {\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 {\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 ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/users/create_many",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
"create_many"
]
},
"description": "Accepts an array of up to 100 user objects.\n\n**Note**: To protect the data in your Zendesk account, bulk user imports are not enabled by default in Zendesk accounts. The account owner must contact [Zendesk Customer Support](https://support.zendesk.com/hc/en-us/articles/4408843597850) to enable the imports. A 403 Forbidden\nerror is returned if data imports are not enabled.\n\n#### Allowed For\n\n* Agents, with restrictions on certain actions\n\n#### Specifying an organization\n\nYou can assign a user to an existing organization by setting an\n`organization_id` property in the user object.\n\n#### Response\n\nThis endpoint returns a `job_status` [JSON object](/api-reference/ticketing/ticket-management/job_statuses/#json-format) and queues a background job to do the work.\nUse the [Show Job Status](/api-reference/ticketing/ticket-management/job_statuses/#show-job-status) endpoint to check for the job's completion.\n"
},
"response": [
{
"name": "Success 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 \"users\": [\n {\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 {\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 ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/users/create_many",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
"create_many"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"job_status\": {\n \"id\": \"<string>\",\n \"message\": \"<string>\",\n \"progress\": \"<integer>\",\n \"results\": [\n {\n \"id\": \"<integer>\",\n \"index\": \"<integer>\"\n },\n {\n \"id\": \"<integer>\",\n \"index\": \"<integer>\"\n }\n ],\n \"status\": \"<string>\",\n \"total\": \"<integer>\",\n \"url\": \"<string>\"\n }\n}"
}
]
}
