Zendesk Connector
Documentation
Version: 9
Documentation
Endpoint

Create User

Name

post_user

Description

Create a user [API reference]

Related Tables

Users

Parameters

Parameter Label Required Options Description
There are no parameters

Output Columns

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

Input Columns

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

Examples

SSIS

Use Zendesk Connector in API Source component to read data or in API Destination component to read/write data:

Insert into Users table using API Destination

This Endpoint belongs to Users table, therefore you cannot work with it directly. Use this table and table-operation pair instead:

Zendesk
Users
Insert
SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Create User

Create a new user for specified email id and other information. If user with same email exists then call fails. 

INSERT INTO Users
(
 name
,email
,organization_id
,phone
,default_group_id
,locale
,moderator
,skip_verify_email
,only_private_comments
,signature
,tags
,time_zone
,role
,external_id
,alias
,details
,notes
,remote_photo_url
,user_fields
)
VALUES(
   'Bob Walton'
  ,'bob@abc.com'
  ,5397098432795
  ,'111-222-3333'
  ,114094762733
  ,'en-US'
  ,'false'
  ,'true' --true=do not send verify account email
  ,1 --user can put only private comments
  ,'Best regards, Support Team' --Only agents and admins can have signatures
  ,'["paid","trial","solved"]' 
  ,'America/New_York'
  ,'end-user' --agent or admin 
  ,'zcrm_1558554000052161270'
  ,'some alias'
  ,'some details'
  ,'some notes'
  ,'https://zappysys.com/wp-content/uploads/2021/10/Slider-API-Hub-1.png' --this does not work in INSERT (works only in UPDATE/UPSERT for now)
  ,'{"birthdate": "1981-01-23", "gender": "M"}'
)

Upsert User (Create or Update)

Creates a user if the user does not already exist, or updates an existing user identified by e-mail address or external ID. 

INSERT INTO Users
(
 name
,email
,organization_id
,phone
,default_group_id
,locale
,moderator
,skip_verify_email
,only_private_comments
,signature
,tags
,time_zone
,role
,external_id
,alias
,details
,notes
,remote_photo_url
,user_fields
)
VALUES(
   'Bob Walton'
  ,'bob@abc.com'
  ,5397098432795
  ,'111-222-3333'
  ,114094762733
  ,'en-US'
  ,'false'
  ,'true' --true=do not send verify account email
  ,1 --user can put only private comments
  ,'Best regards, Support Team' --Only agents and admins can have signatures
  ,'["paid","trial","solved"]' 
  ,'America/New_York'
  ,'end-user' --agent or admin 
  ,'zcrm_1558554000052161270'
  ,'some alias'
  ,'some details'
  ,'some notes'
  ,'https://zappysys.com/wp-content/uploads/2021/10/Slider-API-Hub-1.png' --this does not work in INSERT (works only in UPDATE/UPSERT for now)
  ,'{"birthdate": "1981-01-23", "gender": "M"}'
)

post_user endpoint belongs to Users 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:

Create User

Create a new user for specified email id and other information. If user with same email exists then call fails. 

DECLARE @MyQuery NVARCHAR(MAX) = 'INSERT INTO Users
(
 name
,email
,organization_id
,phone
,default_group_id
,locale
,moderator
,skip_verify_email
,only_private_comments
,signature
,tags
,time_zone
,role
,external_id
,alias
,details
,notes
,remote_photo_url
,user_fields
)
VALUES(
   ''Bob Walton''
  ,''bob@abc.com''
  ,5397098432795
  ,''111-222-3333''
  ,114094762733
  ,''en-US''
  ,''false''
  ,''true'' --true=do not send verify account email
  ,1 --user can put only private comments
  ,''Best regards, Support Team'' --Only agents and admins can have signatures
  ,''["paid","trial","solved"]'' 
  ,''America/New_York''
  ,''end-user'' --agent or admin 
  ,''zcrm_1558554000052161270''
  ,''some alias''
  ,''some details''
  ,''some notes''
  ,''https://zappysys.com/wp-content/uploads/2021/10/Slider-API-Hub-1.png'' --this does not work in INSERT (works only in UPDATE/UPSERT for now)
  ,''{"birthdate": "1981-01-23", "gender": "M"}''
)';

EXEC (@MyQuery) AT [LS_TO_ZENDESK_IN_GATEWAY];

Upsert User (Create or Update)

Creates a user if the user does not already exist, or updates an existing user identified by e-mail address or external ID. 

DECLARE @MyQuery NVARCHAR(MAX) = 'INSERT INTO Users
(
 name
,email
,organization_id
,phone
,default_group_id
,locale
,moderator
,skip_verify_email
,only_private_comments
,signature
,tags
,time_zone
,role
,external_id
,alias
,details
,notes
,remote_photo_url
,user_fields
)
VALUES(
   ''Bob Walton''
  ,''bob@abc.com''
  ,5397098432795
  ,''111-222-3333''
  ,114094762733
  ,''en-US''
  ,''false''
  ,''true'' --true=do not send verify account email
  ,1 --user can put only private comments
  ,''Best regards, Support Team'' --Only agents and admins can have signatures
  ,''["paid","trial","solved"]'' 
  ,''America/New_York''
  ,''end-user'' --agent or admin 
  ,''zcrm_1558554000052161270''
  ,''some alias''
  ,''some details''
  ,''some notes''
  ,''https://zappysys.com/wp-content/uploads/2021/10/Slider-API-Hub-1.png'' --this does not work in INSERT (works only in UPDATE/UPSERT for now)
  ,''{"birthdate": "1981-01-23", "gender": "M"}''
)';

EXEC (@MyQuery) AT [LS_TO_ZENDESK_IN_GATEWAY];

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