autoit / Support API / 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.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
$oHttp.BasicAuth = True
$oHttp.Login = "login"
$oHttp.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>"
; }
; }
$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("user.name","<string>")
$oJson.UpdateString("user.email","<string>")
$oJson.UpdateString("user.custom_role_id","<integer>")
$oJson.UpdateString("user.external_id","<string>")
$oJson.UpdateString("user.identities[0].type","<string>")
$oJson.UpdateString("user.identities[0].value","<string>")
$oJson.UpdateString("user.identities[1].type","<string>")
$oJson.UpdateString("user.identities[1].value","<string>")
$oJson.UpdateString("user.organization.name","<string>")
$oJson.UpdateString("user.organization_id","<integer>")
$oJson.UpdateString("user.role","<string>")
$oHttp.SetRequestHeader "Content-Type","application/json"
$oHttp.SetRequestHeader "Accept","application/json"
$oSbRequestBody = ObjCreate("Chilkat.StringBuilder")
$oJson.EmitSb($oSbRequestBody)
Local $oResp = $oHttp.PTextSb("PUT","https://example.zendesk.com/api/v2/users/update_many?ids=<string>&external_ids=<string>",$oSbRequestBody,"utf-8","application/json",False,False)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $sId
Local $sIndex
Local $sId = $oJResp.StringOf("job_status.id")
Local $sMessage = $oJResp.StringOf("job_status.message")
Local $sProgress = $oJResp.StringOf("job_status.progress")
Local $sStatus = $oJResp.StringOf("job_status.status")
Local $sTotal = $oJResp.StringOf("job_status.total")
Local $sV_Url = $oJResp.StringOf("job_status.url")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("job_status.results")
While $i < $iCount_i
$oJResp.I = $i
$sId = $oJResp.StringOf("job_status.results[i].id")
$sIndex = $oJResp.StringOf("job_status.results[i].index")
$i = $i + 1
Wend
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}"
}
]
}
