PowerBuilder / Support API / Permanently Delete User
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Id
string ls_V_Url
string ls_Name
string ls_V_Email
string ls_Created_at
string ls_Updated_at
string ls_Time_zone
string ls_Phone
string ls_Shared_phone_number
string ls_Locale_id
string ls_Locale
string ls_Organization_id
string ls_Role
string ls_Active
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_Http.BasicAuth = 1
loo_Http.Login = "login"
loo_Http.Password = "password"
loo_Http.SetRequestHeader("Accept","application/json")
loo_Resp = loo_Http.QuickRequest("DELETE","https://example.zendesk.com/api/v2/deleted_users/:deleted_user_id")
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
return
end if
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_Resp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "deleted_user": {
// "id": "<integer>",
// "url": "<string>",
// "name": "<string>",
// "email": "<null>",
// "created_at": "<string>",
// "updated_at": "<string>",
// "time_zone": "<string>",
// "phone": "<string>",
// "shared_phone_number": "<string>",
// "photo": {},
// "locale_id": "<integer>",
// "locale": "<string>",
// "organization_id": "<null>",
// "role": "<string>",
// "active": "<boolean>"
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
ls_Id = loo_JResp.StringOf("deleted_user.id")
ls_V_Url = loo_JResp.StringOf("deleted_user.url")
ls_Name = loo_JResp.StringOf("deleted_user.name")
ls_V_Email = loo_JResp.StringOf("deleted_user.email")
ls_Created_at = loo_JResp.StringOf("deleted_user.created_at")
ls_Updated_at = loo_JResp.StringOf("deleted_user.updated_at")
ls_Time_zone = loo_JResp.StringOf("deleted_user.time_zone")
ls_Phone = loo_JResp.StringOf("deleted_user.phone")
ls_Shared_phone_number = loo_JResp.StringOf("deleted_user.shared_phone_number")
ls_Locale_id = loo_JResp.StringOf("deleted_user.locale_id")
ls_Locale = loo_JResp.StringOf("deleted_user.locale")
ls_Organization_id = loo_JResp.StringOf("deleted_user.organization_id")
ls_Role = loo_JResp.StringOf("deleted_user.role")
ls_Active = loo_JResp.StringOf("deleted_user.active")
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
Curl Command
curl -u login:password -X DELETE
-H "Accept: application/json"
https://example.zendesk.com/api/v2/deleted_users/:deleted_user_id
Postman Collection Item JSON
{
"name": "Permanently Delete User",
"request": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/deleted_users/:deleted_user_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"deleted_users",
":deleted_user_id"
],
"variable": [
{
"key": "deleted_user_id",
"value": "<integer>"
}
]
},
"description": "Before permanently deleting a user, you must delete the user first. See [Delete User](/api-reference/ticketing/users/users/#delete-user).\n\nWARNING: Permanently deleting a user deletes all of their information. This information is not recoverable.\n\n#### Permanent user deletion rate limit\n\nYou can permanently delete 700 users every 10 minutes.\nThe rate limiting mechanism behaves as described in\n[Rates Limits](/api-reference/introduction/rate-limits/#monitoring-your-request-activity) in the API introduction.\nZendesk recommends that you obey the Retry-After header values.\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/deleted_users/:deleted_user_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"deleted_users",
":deleted_user_id"
],
"variable": [
{
"key": "deleted_user_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"deleted_user\": {\n \"id\": \"<integer>\",\n \"url\": \"<string>\",\n \"name\": \"<string>\",\n \"email\": \"<null>\",\n \"created_at\": \"<string>\",\n \"updated_at\": \"<string>\",\n \"time_zone\": \"<string>\",\n \"phone\": \"<string>\",\n \"shared_phone_number\": \"<string>\",\n \"photo\": {},\n \"locale_id\": \"<integer>\",\n \"locale\": \"<string>\",\n \"organization_id\": \"<null>\",\n \"role\": \"<string>\",\n \"active\": \"<boolean>\"\n }\n}"
}
]
}
