autoit / Support API / Delete User
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_9_5_0.Http")
Local $bSuccess
$oHttp.BasicAuth = True
$oHttp.Login = "login"
$oHttp.Password = "password"
$oHttp.SetRequestHeader "Accept","application/json"
Local $oResp = $oHttp.QuickRequest("DELETE","https://example.zendesk.com/api/v2/users/:user_id")
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat_9_5_0.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat_9_5_0.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)
; {
; "user": {
; "name": "<string>",
; "active": "<boolean>",
; "alias": "<string>",
; "chat_only": "<boolean>",
; "created_at": "<string>",
; "custom_role_id": "<integer>",
; "default_group_id": "<integer>",
; "details": "<string>",
; "email": "<string>",
; "external_id": "<string>",
; "iana_time_zone": "<string>",
; "id": "<integer>",
; "last_login_at": "<string>",
; "locale": "<string>",
; "locale_id": "<integer>",
; "moderator": "<boolean>",
; "notes": "<string>",
; "only_private_comments": "<boolean>",
; "organization_id": "<integer>",
; "phone": "<string>",
; "photo": {
; "dolorea1": false,
; "deserunt3": 95124319.10825741
; },
; "remote_photo_url": "<string>",
; "report_csv": "<boolean>",
; "restricted_agent": "<boolean>",
; "role": "<string>",
; "role_type": "<integer>",
; "shared": "<boolean>",
; "shared_agent": "<boolean>",
; "shared_phone_number": "<boolean>",
; "signature": "<string>",
; "suspended": "<boolean>",
; "tags": "<array>",
; "ticket_restriction": "<string>",
; "time_zone": "<string>",
; "two_factor_auth_enabled": "<boolean>",
; "updated_at": "<string>",
; "url": "<string>",
; "user_fields": {
; "nostrudacc": -12929960.546221554,
; "in_80e": 25167751.960886702,
; "proident_e2": true,
; "voluptate_98": -58995022
; },
; "verified": "<boolean>"
; }
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Local $sName = $oJResp.StringOf("user.name")
Local $sActive = $oJResp.StringOf("user.active")
Local $sAlias = $oJResp.StringOf("user.alias")
Local $sChat_only = $oJResp.StringOf("user.chat_only")
Local $sCreated_at = $oJResp.StringOf("user.created_at")
Local $sCustom_role_id = $oJResp.StringOf("user.custom_role_id")
Local $sDefault_group_id = $oJResp.StringOf("user.default_group_id")
Local $sDetails = $oJResp.StringOf("user.details")
Local $sV_Email = $oJResp.StringOf("user.email")
Local $sExternal_id = $oJResp.StringOf("user.external_id")
Local $sIana_time_zone = $oJResp.StringOf("user.iana_time_zone")
Local $sId = $oJResp.StringOf("user.id")
Local $sLast_login_at = $oJResp.StringOf("user.last_login_at")
Local $sLocale = $oJResp.StringOf("user.locale")
Local $sLocale_id = $oJResp.StringOf("user.locale_id")
Local $sModerator = $oJResp.StringOf("user.moderator")
Local $sNotes = $oJResp.StringOf("user.notes")
Local $sOnly_private_comments = $oJResp.StringOf("user.only_private_comments")
Local $sOrganization_id = $oJResp.StringOf("user.organization_id")
Local $sPhone = $oJResp.StringOf("user.phone")
Local $bDolorea1 = $oJResp.BoolOf("user.photo.dolorea1")
Local $sDeserunt3 = $oJResp.StringOf("user.photo.deserunt3")
Local $sRemote_photo_url = $oJResp.StringOf("user.remote_photo_url")
Local $sReport_csv = $oJResp.StringOf("user.report_csv")
Local $sRestricted_agent = $oJResp.StringOf("user.restricted_agent")
Local $sRole = $oJResp.StringOf("user.role")
Local $sRole_type = $oJResp.StringOf("user.role_type")
Local $sV_Shared = $oJResp.StringOf("user.shared")
Local $sShared_agent = $oJResp.StringOf("user.shared_agent")
Local $sShared_phone_number = $oJResp.StringOf("user.shared_phone_number")
Local $sSignature = $oJResp.StringOf("user.signature")
Local $sSuspended = $oJResp.StringOf("user.suspended")
Local $sTags = $oJResp.StringOf("user.tags")
Local $sTicket_restriction = $oJResp.StringOf("user.ticket_restriction")
Local $sTime_zone = $oJResp.StringOf("user.time_zone")
Local $sTwo_factor_auth_enabled = $oJResp.StringOf("user.two_factor_auth_enabled")
Local $sUpdated_at = $oJResp.StringOf("user.updated_at")
Local $sV_Url = $oJResp.StringOf("user.url")
Local $sNostrudacc = $oJResp.StringOf("user.user_fields.nostrudacc")
Local $sIn_80e = $oJResp.StringOf("user.user_fields.in_80e")
Local $bProident_e2 = $oJResp.BoolOf("user.user_fields.proident_e2")
Local $iVoluptate_98 = $oJResp.IntOf("user.user_fields.voluptate_98")
Local $sVerified = $oJResp.StringOf("user.verified")
Curl Command
curl -u login:password -X DELETE
-H "Accept: application/json"
https://example.zendesk.com/api/v2/users/:user_id
Postman Collection Item JSON
{
"name": "Delete User",
"request": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id"
],
"variable": [
{
"key": "user_id",
"value": "<integer>"
}
]
},
"description": "Deletes the user and associated records from the account.\n\n**Warning**: Deleted users are not recoverable.\n\nTo comply with GDPR, a further step is needed. See [Permanently Delete User](/api-reference/ticketing/users/users/#permanently-delete-user).\n\n#### Allowed For\n\n* Agents, with restrictions on certain actions\n"
},
"response": [
{
"name": "Success response",
"originalRequest": {
"method": "DELETE",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id"
],
"variable": [
{
"key": "user_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"user\": {\n \"name\": \"<string>\",\n \"active\": \"<boolean>\",\n \"alias\": \"<string>\",\n \"chat_only\": \"<boolean>\",\n \"created_at\": \"<string>\",\n \"custom_role_id\": \"<integer>\",\n \"default_group_id\": \"<integer>\",\n \"details\": \"<string>\",\n \"email\": \"<string>\",\n \"external_id\": \"<string>\",\n \"iana_time_zone\": \"<string>\",\n \"id\": \"<integer>\",\n \"last_login_at\": \"<string>\",\n \"locale\": \"<string>\",\n \"locale_id\": \"<integer>\",\n \"moderator\": \"<boolean>\",\n \"notes\": \"<string>\",\n \"only_private_comments\": \"<boolean>\",\n \"organization_id\": \"<integer>\",\n \"phone\": \"<string>\",\n \"photo\": {\n \"dolorea1\": false,\n \"deserunt3\": 95124319.10825741\n },\n \"remote_photo_url\": \"<string>\",\n \"report_csv\": \"<boolean>\",\n \"restricted_agent\": \"<boolean>\",\n \"role\": \"<string>\",\n \"role_type\": \"<integer>\",\n \"shared\": \"<boolean>\",\n \"shared_agent\": \"<boolean>\",\n \"shared_phone_number\": \"<boolean>\",\n \"signature\": \"<string>\",\n \"suspended\": \"<boolean>\",\n \"tags\": \"<array>\",\n \"ticket_restriction\": \"<string>\",\n \"time_zone\": \"<string>\",\n \"two_factor_auth_enabled\": \"<boolean>\",\n \"updated_at\": \"<string>\",\n \"url\": \"<string>\",\n \"user_fields\": {\n \"nostrudacc\": -12929960.546221554,\n \"in_80e\": 25167751.960886702,\n \"proident_e2\": true,\n \"voluptate_98\": -58995022\n },\n \"verified\": \"<boolean>\"\n }\n}"
}
]
}
