VB6 / Support API / Create Or Update Many Users
Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New ChilkatHttp
Dim success As Long
http.BasicAuth = 1
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.
' {
' "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>"
' }
' ]
' }
Dim json As New ChilkatJsonObject
success = json.UpdateString("users[0].name","<string>")
success = json.UpdateString("users[0].email","<string>")
success = json.UpdateString("users[0].custom_role_id","<integer>")
success = json.UpdateString("users[0].external_id","<string>")
success = json.UpdateString("users[0].identities[0].type","<string>")
success = json.UpdateString("users[0].identities[0].value","<string>")
success = json.UpdateString("users[0].identities[1].type","<string>")
success = json.UpdateString("users[0].identities[1].value","<string>")
success = json.UpdateString("users[0].organization.name","<string>")
success = json.UpdateString("users[0].organization_id","<integer>")
success = json.UpdateString("users[0].role","<string>")
success = json.UpdateString("users[1].name","<string>")
success = json.UpdateString("users[1].email","<string>")
success = json.UpdateString("users[1].custom_role_id","<integer>")
success = json.UpdateString("users[1].external_id","<string>")
success = json.UpdateString("users[1].identities[0].type","<string>")
success = json.UpdateString("users[1].identities[0].value","<string>")
success = json.UpdateString("users[1].identities[1].type","<string>")
success = json.UpdateString("users[1].identities[1].value","<string>")
success = json.UpdateString("users[1].organization.name","<string>")
success = json.UpdateString("users[1].organization_id","<integer>")
success = json.UpdateString("users[1].role","<string>")
http.SetRequestHeader "Content-Type","application/json"
http.SetRequestHeader "Accept","application/json"
Dim resp As ChilkatHttpResponse
Set resp = http.PostJson3("https://example.zendesk.com/api/v2/users/create_or_update_many","application/json",json)
If (http.LastMethodSuccess = 0) Then
Debug.Print http.LastErrorText
Exit Sub
End If
Dim sbResponseBody As New ChilkatStringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0
Debug.Print "Response Body:"
Debug.Print jResp.Emit()
Dim respStatusCode As Long
respStatusCode = resp.StatusCode
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
Debug.Print "Response Header:"
Debug.Print resp.Header
Debug.Print "Failed."
Exit Sub
End If
' 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
Dim id As String
Dim index As String
Dim Id As String
Id = jResp.StringOf("job_status.id")
Dim Message As String
Message = jResp.StringOf("job_status.message")
Dim Progress As String
Progress = jResp.StringOf("job_status.progress")
Dim Status As String
Status = jResp.StringOf("job_status.status")
Dim Total As String
Total = jResp.StringOf("job_status.total")
Dim v_Url As String
v_Url = jResp.StringOf("job_status.url")
Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("job_status.results")
Do While i < count_i
jResp.I = i
id = jResp.StringOf("job_status.results[i].id")
index = jResp.StringOf("job_status.results[i].index")
i = i + 1
Loop
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_or_update_many
Postman Collection Item JSON
{
"name": "Create Or Update 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_or_update_many",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
"create_or_update_many"
]
},
"description": "Accepts an array of up to 100 user objects. For each user, the user is created if it does not\nalready exist, or the existing user is updated.\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\nEach individual user object can identify an existing user by `email` or by `external_id`.\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\n#### Allowed For\n\n* Agents, with restrictions on certain actions\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_or_update_many",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
"create_or_update_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}"
}
]
}
