Chilkat Online Tools

VB.NET / 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 Chilkat.Http
Dim success As Boolean

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.

' {
'   "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 Chilkat.JsonObject
json.UpdateString("users[0].name","<string>")
json.UpdateString("users[0].email","<string>")
json.UpdateString("users[0].custom_role_id","<integer>")
json.UpdateString("users[0].external_id","<string>")
json.UpdateString("users[0].identities[0].type","<string>")
json.UpdateString("users[0].identities[0].value","<string>")
json.UpdateString("users[0].identities[1].type","<string>")
json.UpdateString("users[0].identities[1].value","<string>")
json.UpdateString("users[0].organization.name","<string>")
json.UpdateString("users[0].organization_id","<integer>")
json.UpdateString("users[0].role","<string>")
json.UpdateString("users[1].name","<string>")
json.UpdateString("users[1].email","<string>")
json.UpdateString("users[1].custom_role_id","<integer>")
json.UpdateString("users[1].external_id","<string>")
json.UpdateString("users[1].identities[0].type","<string>")
json.UpdateString("users[1].identities[0].value","<string>")
json.UpdateString("users[1].identities[1].type","<string>")
json.UpdateString("users[1].identities[1].value","<string>")
json.UpdateString("users[1].organization.name","<string>")
json.UpdateString("users[1].organization_id","<integer>")
json.UpdateString("users[1].role","<string>")

http.SetRequestHeader("Content-Type","application/json")
http.SetRequestHeader("Accept","application/json")

Dim resp As Chilkat.HttpResponse = http.PostJson3("https://example.zendesk.com/api/v2/users/create_or_update_many","application/json",json)
If (http.LastMethodSuccess = False) Then
    Debug.WriteLine(http.LastErrorText)
    Exit Sub
End If


Dim sbResponseBody As New Chilkat.StringBuilder
resp.GetBodySb(sbResponseBody)

Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())

Dim respStatusCode As Integer = resp.StatusCode
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
    Debug.WriteLine("Response Header:")
    Debug.WriteLine(resp.Header)
    Debug.WriteLine("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 = jResp.StringOf("job_status.id")
Dim Message As String = jResp.StringOf("job_status.message")
Dim Progress As String = jResp.StringOf("job_status.progress")
Dim Status As String = jResp.StringOf("job_status.status")
Dim Total As String = jResp.StringOf("job_status.total")
Dim v_Url As String = jResp.StringOf("job_status.url")
Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("job_status.results")
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
End While

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}"
    }
  ]
}