Chilkat Online Tools

Foxpro / Support API / Permanently Delete User

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcId
LOCAL lcV_Url
LOCAL lcName
LOCAL lcV_Email
LOCAL lcCreated_at
LOCAL lcUpdated_at
LOCAL lcTime_zone
LOCAL lcPhone
LOCAL lcShared_phone_number
LOCAL lcLocale_id
LOCAL lcLocale
LOCAL lcOrganization_id
LOCAL lcRole
LOCAL lcActive

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

loHttp.BasicAuth = 1
loHttp.Login = "login"
loHttp.Password = "password"

loHttp.SetRequestHeader("Accept","application/json")

loResp = loHttp.QuickRequest("DELETE","https://example.zendesk.com/api/v2/deleted_users/:deleted_user_id")
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    RELEASE loResp
    RELEASE loHttp
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

RELEASE loResp

* 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

lcId = loJResp.StringOf("deleted_user.id")
lcV_Url = loJResp.StringOf("deleted_user.url")
lcName = loJResp.StringOf("deleted_user.name")
lcV_Email = loJResp.StringOf("deleted_user.email")
lcCreated_at = loJResp.StringOf("deleted_user.created_at")
lcUpdated_at = loJResp.StringOf("deleted_user.updated_at")
lcTime_zone = loJResp.StringOf("deleted_user.time_zone")
lcPhone = loJResp.StringOf("deleted_user.phone")
lcShared_phone_number = loJResp.StringOf("deleted_user.shared_phone_number")
lcLocale_id = loJResp.StringOf("deleted_user.locale_id")
lcLocale = loJResp.StringOf("deleted_user.locale")
lcOrganization_id = loJResp.StringOf("deleted_user.organization_id")
lcRole = loJResp.StringOf("deleted_user.role")
lcActive = loJResp.StringOf("deleted_user.active")

RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp

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