PureBasic / Support API / Create Many Users
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
CkHttp::setCkBasicAuth(http, 1)
CkHttp::setCkLogin(http, "login")
CkHttp::setCkPassword(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>"
; }
; ]
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"users[0].name","<string>")
CkJsonObject::ckUpdateString(json,"users[0].email","<string>")
CkJsonObject::ckUpdateString(json,"users[0].custom_role_id","<integer>")
CkJsonObject::ckUpdateString(json,"users[0].external_id","<string>")
CkJsonObject::ckUpdateString(json,"users[0].identities[0].type","<string>")
CkJsonObject::ckUpdateString(json,"users[0].identities[0].value","<string>")
CkJsonObject::ckUpdateString(json,"users[0].identities[1].type","<string>")
CkJsonObject::ckUpdateString(json,"users[0].identities[1].value","<string>")
CkJsonObject::ckUpdateString(json,"users[0].organization.name","<string>")
CkJsonObject::ckUpdateString(json,"users[0].organization_id","<integer>")
CkJsonObject::ckUpdateString(json,"users[0].role","<string>")
CkJsonObject::ckUpdateString(json,"users[1].name","<string>")
CkJsonObject::ckUpdateString(json,"users[1].email","<string>")
CkJsonObject::ckUpdateString(json,"users[1].custom_role_id","<integer>")
CkJsonObject::ckUpdateString(json,"users[1].external_id","<string>")
CkJsonObject::ckUpdateString(json,"users[1].identities[0].type","<string>")
CkJsonObject::ckUpdateString(json,"users[1].identities[0].value","<string>")
CkJsonObject::ckUpdateString(json,"users[1].identities[1].type","<string>")
CkJsonObject::ckUpdateString(json,"users[1].identities[1].value","<string>")
CkJsonObject::ckUpdateString(json,"users[1].organization.name","<string>")
CkJsonObject::ckUpdateString(json,"users[1].organization_id","<integer>")
CkJsonObject::ckUpdateString(json,"users[1].role","<string>")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
resp.i = CkHttp::ckPostJson3(http,"https://example.zendesk.com/api/v2/users/create_many","application/json",json)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(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
id.s
index.s
Id.s = CkJsonObject::ckStringOf(jResp,"job_status.id")
Message.s = CkJsonObject::ckStringOf(jResp,"job_status.message")
Progress.s = CkJsonObject::ckStringOf(jResp,"job_status.progress")
Status.s = CkJsonObject::ckStringOf(jResp,"job_status.status")
Total.s = CkJsonObject::ckStringOf(jResp,"job_status.total")
v_Url.s = CkJsonObject::ckStringOf(jResp,"job_status.url")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"job_status.results")
While i < count_i
CkJsonObject::setCkI(jResp, i)
id = CkJsonObject::ckStringOf(jResp,"job_status.results[i].id")
index = CkJsonObject::ckStringOf(jResp,"job_status.results[i].index")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}
