Chilkat Online Tools

Swift / Support API / Permanently Delete User

Back to Collection Items

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

    let http = CkoHttp()
    var success: Bool

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

    http.SetRequestHeader("Accept", value: "application/json")

    var resp: CkoHttpResponse? = http.QuickRequest("DELETE", url: "https://example.zendesk.com/api/v2/deleted_users/:deleted_user_id")
    if http.LastMethodSuccess == false {
        print("\(http.LastErrorText)")
        return
    }

    let sbResponseBody = CkoStringBuilder()
    resp!.GetBodySb(sbResponseBody)

    let jResp = CkoJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.EmitCompact = false

    print("Response Body:")
    print("\(jResp.Emit())")

    var respStatusCode: Int = resp!.StatusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.Header)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

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

    var Id: String? = jResp.StringOf("deleted_user.id")
    var v_Url: String? = jResp.StringOf("deleted_user.url")
    var Name: String? = jResp.StringOf("deleted_user.name")
    var v_Email: String? = jResp.StringOf("deleted_user.email")
    var Created_at: String? = jResp.StringOf("deleted_user.created_at")
    var Updated_at: String? = jResp.StringOf("deleted_user.updated_at")
    var Time_zone: String? = jResp.StringOf("deleted_user.time_zone")
    var Phone: String? = jResp.StringOf("deleted_user.phone")
    var Shared_phone_number: String? = jResp.StringOf("deleted_user.shared_phone_number")
    var Locale_id: String? = jResp.StringOf("deleted_user.locale_id")
    var Locale: String? = jResp.StringOf("deleted_user.locale")
    var Organization_id: String? = jResp.StringOf("deleted_user.organization_id")
    var Role: String? = jResp.StringOf("deleted_user.role")
    var Active: String? = 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}"
    }
  ]
}