Reference

Endpoint Upsert Users (Bulk) - Create or Update

Name

upsert_users

Description

Create or Update users in bulk (Upsert) [API reference]

Related Tables

Users_Bulk

Parameters

Parameter	Required	Options
There are no parameters

Output Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length
id	`DT_I8`	`bigint`
email	`DT_WSTR`	`nvarchar(100)`	100
status	`DT_WSTR`	`nvarchar(50)`	50
success	`DT_BOOL`	`bit`
job_id	`DT_WSTR`	`nvarchar(100)`	100
message	`DT_WSTR`	`nvarchar(2000)`	2000
total	`DT_I4`	`int`
job_status	`DT_WSTR`	`nvarchar(50)`	50
job_url	`DT_WSTR`	`nvarchar(500)`	500
index	`DT_I4`	`int`
error	`DT_WSTR`	`nvarchar(1000)`	1000
details	`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
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 Destination

This Endpoint belongs to the Users_Bulk table, therefore it is better to use it, instead of accessing the endpoint directly. Use this table and table-operation pair to upsert users - create or update:

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_Bulk

Insert, Update, Upsert

There are no parameters to configure.

SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Upsert Users (Bulk) - Create or Update

-- We are out of SQL query examples for this Endpoint, sorry!
-- But will try to get some very very soon!

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

Upsert Users (Bulk) - Create or Update

DECLARE @MyQuery NVARCHAR(MAX) = '-- We are out of SQL query examples for this Endpoint, sorry!
-- But will try to get some very very soon!';

EXEC (@MyQuery) AT [LS_TO_ZENDESK_IN_GATEWAY];

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