TCL / Support API / Permanently Delete User
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "login"
CkHttp_put_Password $http "password"
CkHttp_SetRequestHeader $http "Accept" "application/json"
# resp is a CkHttpResponse
set resp [CkHttp_QuickRequest $http "DELETE" "https://example.zendesk.com/api/v2/deleted_users/:deleted_user_id"]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $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
set Id [CkJsonObject_stringOf $jResp "deleted_user.id"]
set v_Url [CkJsonObject_stringOf $jResp "deleted_user.url"]
set Name [CkJsonObject_stringOf $jResp "deleted_user.name"]
set v_Email [CkJsonObject_stringOf $jResp "deleted_user.email"]
set Created_at [CkJsonObject_stringOf $jResp "deleted_user.created_at"]
set Updated_at [CkJsonObject_stringOf $jResp "deleted_user.updated_at"]
set Time_zone [CkJsonObject_stringOf $jResp "deleted_user.time_zone"]
set Phone [CkJsonObject_stringOf $jResp "deleted_user.phone"]
set Shared_phone_number [CkJsonObject_stringOf $jResp "deleted_user.shared_phone_number"]
set Locale_id [CkJsonObject_stringOf $jResp "deleted_user.locale_id"]
set Locale [CkJsonObject_stringOf $jResp "deleted_user.locale"]
set Organization_id [CkJsonObject_stringOf $jResp "deleted_user.organization_id"]
set Role [CkJsonObject_stringOf $jResp "deleted_user.role"]
set Active [CkJsonObject_stringOf $jResp "deleted_user.active"]
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $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}"
}
]
}