Reference

Endpoint Delete User


Name

delete_user

Description

Delete a user by its id [API reference]

Related Tables

Users , Users_Bulk

Parameters

Parameter Required Options
Name: id

Label: User ID for Delete

YES

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
id DT_I8 bigint
name DT_WSTR nvarchar(255) 255
email DT_WSTR nvarchar(500) 500
active DT_BOOL bit
role DT_WSTR nvarchar(32) 32
created_at DT_DBTIMESTAMP datetime
updated_at DT_DBTIMESTAMP datetime
time_zone DT_WSTR nvarchar(100) 100
iana_time_zone DT_WSTR nvarchar(100) 100
phone DT_WSTR nvarchar(100) 100
url DT_WSTR nvarchar(500) 500
shared_phone_number DT_BOOL bit
locale_id DT_I8 bigint
locale DT_WSTR nvarchar(20) 20
organization_id DT_I8 bigint
role_type DT_I8 bigint
verified DT_BOOL bit
external_id DT_WSTR nvarchar(500) 500
tags DT_WSTR nvarchar(1000) 1000
tags_1 DT_WSTR nvarchar(50) 50
tags_2 DT_WSTR nvarchar(50) 50
tags_3 DT_WSTR nvarchar(50) 50
tags_4 DT_WSTR nvarchar(50) 50
tags_5 DT_WSTR nvarchar(50) 50
alias DT_WSTR nvarchar(255) 255
shared DT_BOOL bit
shared_agent DT_BOOL bit
last_login_at DT_DBTIMESTAMP datetime
two_factor_auth_enabled DT_BOOL bit
signature DT_WSTR nvarchar(80) 80
details DT_WSTR nvarchar(4000) 4000
notes DT_WSTR nvarchar(4000) 4000
custom_role_id DT_I8 bigint
moderator DT_BOOL bit
ticket_restriction DT_WSTR nvarchar(80) 80
only_private_comments DT_BOOL bit
restricted_agent DT_BOOL bit
suspended DT_BOOL bit
default_group_id DT_I8 bigint
report_csv DT_BOOL bit
photo_url DT_WSTR nvarchar(500) 500
photo_id DT_I8 bigint
photo_file_name DT_WSTR nvarchar(148) 148
photo_content_url DT_WSTR nvarchar(500) 500
photo_mapped_content_url DT_WSTR nvarchar(500) 500
photo_content_type DT_WSTR nvarchar(40) 40
photo_size DT_I8 bigint
photo_width DT_I8 bigint
photo_height DT_I8 bigint
photo_inline DT_BOOL bit
photo_deleted DT_BOOL bit
photo_thumbnails DT_WSTR nvarchar(4000) 4000
user_field_dt_[$parent.key$] DT_WSTR nvarchar(4000) 4000
user_field_[$parent.key$] DT_WSTR nvarchar(4000) 4000
If the column you are looking for is missing, consider customizing Zendesk Connector.

Input Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
external_id DT_WSTR nvarchar(500) 500
default_group_id DT_I8 bigint
email DT_WSTR nvarchar(160) 160
alias DT_WSTR nvarchar(255) 255
custom_role_id DT_I8 bigint
details DT_WSTR nvarchar(4000) 4000
id DT_I8 bigint
photo_id DT_WSTR nvarchar(1020) 1020
photo DT_WSTR nvarchar(4000) 4000
name DT_WSTR nvarchar(120) 120
suspended DT_BOOL bit
restricted_agent DT_BOOL bit
only_private_comments DT_BOOL bit
ticket_restriction DT_WSTR nvarchar(80) 80
moderator DT_BOOL bit
time_zone DT_WSTR nvarchar(104) 104
remote_photo_url DT_WSTR nvarchar(4000) 4000
shared_phone_number DT_BOOL bit
notes DT_WSTR nvarchar(4000) 4000
signature DT_WSTR nvarchar(4000) 4000
tags DT_WSTR nvarchar(4000) 4000
user_fields DT_WSTR nvarchar(4000) 4000
verified DT_BOOL bit
role DT_WSTR nvarchar(100) 100
organization_name DT_WSTR nvarchar(200) 200
organization_id DT_I8 bigint
locale DT_WSTR nvarchar(20) 20
locale_id DT_I8 bigint
phone DT_WSTR nvarchar(80) 80
identities DT_WSTR nvarchar(4000) 4000
Required columns that you need to supply are bolded.

Examples

SSIS

Use Zendesk Connector in API Source or in API Destination SSIS Data Flow components to read or write data.

API Source

API Source - Zendesk
Zendesk Connector can be used to integrate Zendesk REST API in your App / BI Tools. You can read/write data about Tickets, Activity, Users, Organizations and more.
Zendesk
Delete User
Required Parameters
User ID for Delete Fill-in the parameter...
SSIS API Source - Read from table or endpoint

API Destination

This Endpoint belongs to the Users table, therefore it is better to use it, instead of accessing the endpoint directly. Use this table and table-operation pair to delete user:

API Destination - Zendesk
Zendesk Connector can be used to integrate Zendesk REST API in your App / BI Tools. You can read/write data about Tickets, Activity, Users, Organizations and more.
Zendesk
Users
Delete
Required Parameters
User ID for Delete Fill-in the parameter...
SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Delete User

DELETE FROM Users Where id=21855694556443 --it doesnt delete user from system but only changes active flag

delete_user endpoint belongs to Users , Users_Bulk table(s), and can therefore be used via those table(s).

SQL Server

Use these SQL queries in SQL Server after you create a data source in Data Gateway:

Delete User

DECLARE @MyQuery NVARCHAR(MAX) = 'DELETE FROM Users Where id=21855694556443 --it doesnt delete user from system but only changes active flag';

EXEC (@MyQuery) AT [LS_TO_ZENDESK_IN_GATEWAY];

delete_user endpoint belongs to Users , Users_Bulk table(s), and can therefore be used via those table(s).