Chilkat Tools

TCL / Support API / Delete User

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/users/: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)

# {
#   "user": {
#     "name": "<string>",
#     "active": "<boolean>",
#     "alias": "<string>",
#     "chat_only": "<boolean>",
#     "created_at": "<string>",
#     "custom_role_id": "<integer>",
#     "default_group_id": "<integer>",
#     "details": "<string>",
#     "email": "<string>",
#     "external_id": "<string>",
#     "iana_time_zone": "<string>",
#     "id": "<integer>",
#     "last_login_at": "<string>",
#     "locale": "<string>",
#     "locale_id": "<integer>",
#     "moderator": "<boolean>",
#     "notes": "<string>",
#     "only_private_comments": "<boolean>",
#     "organization_id": "<integer>",
#     "phone": "<string>",
#     "photo": {
#       "dolorea1": false,
#       "deserunt3": 95124319.10825741
#     },
#     "remote_photo_url": "<string>",
#     "report_csv": "<boolean>",
#     "restricted_agent": "<boolean>",
#     "role": "<string>",
#     "role_type": "<integer>",
#     "shared": "<boolean>",
#     "shared_agent": "<boolean>",
#     "shared_phone_number": "<boolean>",
#     "signature": "<string>",
#     "suspended": "<boolean>",
#     "tags": "<array>",
#     "ticket_restriction": "<string>",
#     "time_zone": "<string>",
#     "two_factor_auth_enabled": "<boolean>",
#     "updated_at": "<string>",
#     "url": "<string>",
#     "user_fields": {
#       "nostrudacc": -12929960.546221554,
#       "in_80e": 25167751.960886702,
#       "proident_e2": true,
#       "voluptate_98": -58995022
#     },
#     "verified": "<boolean>"
#   }
# }

# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

set Name [CkJsonObject_stringOf $jResp "user.name"]
set Active [CkJsonObject_stringOf $jResp "user.active"]
set Alias [CkJsonObject_stringOf $jResp "user.alias"]
set Chat_only [CkJsonObject_stringOf $jResp "user.chat_only"]
set Created_at [CkJsonObject_stringOf $jResp "user.created_at"]
set Custom_role_id [CkJsonObject_stringOf $jResp "user.custom_role_id"]
set Default_group_id [CkJsonObject_stringOf $jResp "user.default_group_id"]
set Details [CkJsonObject_stringOf $jResp "user.details"]
set v_Email [CkJsonObject_stringOf $jResp "user.email"]
set External_id [CkJsonObject_stringOf $jResp "user.external_id"]
set Iana_time_zone [CkJsonObject_stringOf $jResp "user.iana_time_zone"]
set Id [CkJsonObject_stringOf $jResp "user.id"]
set Last_login_at [CkJsonObject_stringOf $jResp "user.last_login_at"]
set Locale [CkJsonObject_stringOf $jResp "user.locale"]
set Locale_id [CkJsonObject_stringOf $jResp "user.locale_id"]
set Moderator [CkJsonObject_stringOf $jResp "user.moderator"]
set Notes [CkJsonObject_stringOf $jResp "user.notes"]
set Only_private_comments [CkJsonObject_stringOf $jResp "user.only_private_comments"]
set Organization_id [CkJsonObject_stringOf $jResp "user.organization_id"]
set Phone [CkJsonObject_stringOf $jResp "user.phone"]
set Dolorea1 [CkJsonObject_BoolOf $jResp "user.photo.dolorea1"]
set Deserunt3 [CkJsonObject_stringOf $jResp "user.photo.deserunt3"]
set Remote_photo_url [CkJsonObject_stringOf $jResp "user.remote_photo_url"]
set Report_csv [CkJsonObject_stringOf $jResp "user.report_csv"]
set Restricted_agent [CkJsonObject_stringOf $jResp "user.restricted_agent"]
set Role [CkJsonObject_stringOf $jResp "user.role"]
set Role_type [CkJsonObject_stringOf $jResp "user.role_type"]
set v_Shared [CkJsonObject_stringOf $jResp "user.shared"]
set Shared_agent [CkJsonObject_stringOf $jResp "user.shared_agent"]
set Shared_phone_number [CkJsonObject_stringOf $jResp "user.shared_phone_number"]
set Signature [CkJsonObject_stringOf $jResp "user.signature"]
set Suspended [CkJsonObject_stringOf $jResp "user.suspended"]
set Tags [CkJsonObject_stringOf $jResp "user.tags"]
set Ticket_restriction [CkJsonObject_stringOf $jResp "user.ticket_restriction"]
set Time_zone [CkJsonObject_stringOf $jResp "user.time_zone"]
set Two_factor_auth_enabled [CkJsonObject_stringOf $jResp "user.two_factor_auth_enabled"]
set Updated_at [CkJsonObject_stringOf $jResp "user.updated_at"]
set v_Url [CkJsonObject_stringOf $jResp "user.url"]
set Nostrudacc [CkJsonObject_stringOf $jResp "user.user_fields.nostrudacc"]
set In_80e [CkJsonObject_stringOf $jResp "user.user_fields.in_80e"]
set Proident_e2 [CkJsonObject_BoolOf $jResp "user.user_fields.proident_e2"]
set Voluptate_98 [CkJsonObject_IntOf $jResp "user.user_fields.voluptate_98"]
set Verified [CkJsonObject_stringOf $jResp "user.verified"]

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/users/:user_id

Postman Collection Item JSON

{
  "name": "Delete User",
  "request": {
    "method": "DELETE",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/users/:user_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "users",
        ":user_id"
      ],
      "variable": [
        {
          "key": "user_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Deletes the user and associated records from the account.\n\n**Warning**: Deleted users are not recoverable.\n\nTo comply with GDPR, a further step is needed. See [Permanently Delete User](/api-reference/ticketing/users/users/#permanently-delete-user).\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/users/:user_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "users",
            ":user_id"
          ],
          "variable": [
            {
              "key": "user_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"user\": {\n    \"name\": \"<string>\",\n    \"active\": \"<boolean>\",\n    \"alias\": \"<string>\",\n    \"chat_only\": \"<boolean>\",\n    \"created_at\": \"<string>\",\n    \"custom_role_id\": \"<integer>\",\n    \"default_group_id\": \"<integer>\",\n    \"details\": \"<string>\",\n    \"email\": \"<string>\",\n    \"external_id\": \"<string>\",\n    \"iana_time_zone\": \"<string>\",\n    \"id\": \"<integer>\",\n    \"last_login_at\": \"<string>\",\n    \"locale\": \"<string>\",\n    \"locale_id\": \"<integer>\",\n    \"moderator\": \"<boolean>\",\n    \"notes\": \"<string>\",\n    \"only_private_comments\": \"<boolean>\",\n    \"organization_id\": \"<integer>\",\n    \"phone\": \"<string>\",\n    \"photo\": {\n      \"dolorea1\": false,\n      \"deserunt3\": 95124319.10825741\n    },\n    \"remote_photo_url\": \"<string>\",\n    \"report_csv\": \"<boolean>\",\n    \"restricted_agent\": \"<boolean>\",\n    \"role\": \"<string>\",\n    \"role_type\": \"<integer>\",\n    \"shared\": \"<boolean>\",\n    \"shared_agent\": \"<boolean>\",\n    \"shared_phone_number\": \"<boolean>\",\n    \"signature\": \"<string>\",\n    \"suspended\": \"<boolean>\",\n    \"tags\": \"<array>\",\n    \"ticket_restriction\": \"<string>\",\n    \"time_zone\": \"<string>\",\n    \"two_factor_auth_enabled\": \"<boolean>\",\n    \"updated_at\": \"<string>\",\n    \"url\": \"<string>\",\n    \"user_fields\": {\n      \"nostrudacc\": -12929960.546221554,\n      \"in_80e\": 25167751.960886702,\n      \"proident_e2\": true,\n      \"voluptate_98\": -58995022\n    },\n    \"verified\": \"<boolean>\"\n  }\n}"
    }
  ]
}

Chilkat Online Tools

TCL / Support API / Delete User

Curl Command

Postman Collection Item JSON