VBScript / Support API / Update Many Users
Back to Collection Items
Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
'Create a Unicode (utf-16) output text file.
Set outFile = fso.CreateTextFile("output.txt", True, True)
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.Http")
set http = CreateObject("Chilkat.Http")
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.
' {
' "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>"
' }
' }
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set json = CreateObject("Chilkat.JsonObject")
success = json.UpdateString("user.name","<string>")
success = json.UpdateString("user.email","<string>")
success = json.UpdateString("user.custom_role_id","<integer>")
success = json.UpdateString("user.external_id","<string>")
success = json.UpdateString("user.identities[0].type","<string>")
success = json.UpdateString("user.identities[0].value","<string>")
success = json.UpdateString("user.identities[1].type","<string>")
success = json.UpdateString("user.identities[1].value","<string>")
success = json.UpdateString("user.organization.name","<string>")
success = json.UpdateString("user.organization_id","<integer>")
success = json.UpdateString("user.role","<string>")
http.SetRequestHeader "Content-Type","application/json"
http.SetRequestHeader "Accept","application/json"
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.StringBuilder")
set sbRequestBody = CreateObject("Chilkat.StringBuilder")
success = json.EmitSb(sbRequestBody)
' resp is a Chilkat.HttpResponse
Set resp = http.PTextSb("PUT","https://example.zendesk.com/api/v2/users/update_many?ids=<string>&external_ids=<string>",sbRequestBody,"utf-8","application/json",0,0)
If (http.LastMethodSuccess = 0) Then
outFile.WriteLine(http.LastErrorText)
WScript.Quit
End If
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.StringBuilder")
set sbResponseBody = CreateObject("Chilkat.StringBuilder")
success = resp.GetBodySb(sbResponseBody)
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set jResp = CreateObject("Chilkat.JsonObject")
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0
outFile.WriteLine("Response Body:")
outFile.WriteLine(jResp.Emit())
respStatusCode = resp.StatusCode
outFile.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
outFile.WriteLine("Response Header:")
outFile.WriteLine(resp.Header)
outFile.WriteLine("Failed.")
WScript.Quit
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
Id = jResp.StringOf("job_status.id")
Message = jResp.StringOf("job_status.message")
Progress = jResp.StringOf("job_status.progress")
Status = jResp.StringOf("job_status.status")
Total = jResp.StringOf("job_status.total")
v_Url = jResp.StringOf("job_status.url")
i = 0
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
outFile.Close
Curl Command
curl -u login:password -X PUT
-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/update_many?ids=<string>&external_ids=<string>
Postman Collection Item JSON
{
"name": "Update Many Users",
"request": {
"method": "PUT",
"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/update_many?ids=<string>&external_ids=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
"update_many"
],
"query": [
{
"key": "ids",
"value": "<string>",
"description": "Id of the users to update. Comma separated"
},
{
"key": "external_ids",
"value": "<string>",
"description": "External Id of the users to update. Comma separated"
}
]
}
},
"response": [
{
"name": "Successful response",
"originalRequest": {
"method": "PUT",
"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/update_many?ids=<string>&external_ids=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
"update_many"
],
"query": [
{
"key": "ids",
"value": "<string>",
"description": "Id of the users to update. Comma separated"
},
{
"key": "external_ids",
"value": "<string>",
"description": "External Id of the users to update. Comma separated"
}
]
}
},
"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}"
}
]
}
