Chilkat Online Tools

Xojo / Support API / Permanently Delete User

Back to Collection Items

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

Dim http As New Chilkat.Http
Dim success As Boolean

http.BasicAuth = True
http.Login = "login"
http.Password = "password"

http.SetRequestHeader "Accept","application/json"

Dim resp As Chilkat.HttpResponse
resp = http.QuickRequest("DELETE","https://example.zendesk.com/api/v2/deleted_users/:deleted_user_id")
If (http.LastMethodSuccess = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

Dim sbResponseBody As New Chilkat.StringBuilder
success = resp.GetBodySb(sbResponseBody)

Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())

Dim respStatusCode As Int32
respStatusCode = resp.StatusCode
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
    System.DebugLog("Response Header:")
    System.DebugLog(resp.Header)
    System.DebugLog("Failed.")

    Return
End If

// 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

Dim Id As String
Id = jResp.StringOf("deleted_user.id")
Dim v_Url As String
v_Url = jResp.StringOf("deleted_user.url")
Dim Name As String
Name = jResp.StringOf("deleted_user.name")
Dim v_Email As String
v_Email = jResp.StringOf("deleted_user.email")
Dim Created_at As String
Created_at = jResp.StringOf("deleted_user.created_at")
Dim Updated_at As String
Updated_at = jResp.StringOf("deleted_user.updated_at")
Dim Time_zone As String
Time_zone = jResp.StringOf("deleted_user.time_zone")
Dim Phone As String
Phone = jResp.StringOf("deleted_user.phone")
Dim Shared_phone_number As String
Shared_phone_number = jResp.StringOf("deleted_user.shared_phone_number")
Dim Locale_id As String
Locale_id = jResp.StringOf("deleted_user.locale_id")
Dim Locale As String
Locale = jResp.StringOf("deleted_user.locale")
Dim Organization_id As String
Organization_id = jResp.StringOf("deleted_user.organization_id")
Dim Role As String
Role = jResp.StringOf("deleted_user.role")
Dim Active As String
Active = jResp.StringOf("deleted_user.active")

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}"
    }
  ]
}