EndPoint Upsert Users (Bulk) - Create or Update
Name
upsert_users
Description
Create or Update users in bulk (Upsert) [API reference]
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 |
||
DT_WSTR
|
nvarchar(100)
|
100 | False |
||
status |
DT_WSTR
|
nvarchar(50)
|
50 | False |
|
success |
DT_BOOL
|
bit
|
False |
||
job_id |
DT_WSTR
|
nvarchar(100)
|
100 | False |
|
message |
DT_WSTR
|
nvarchar(2000)
|
2000 | False |
|
total |
DT_I4
|
int
|
False |
||
job_status |
DT_WSTR
|
nvarchar(50)
|
50 | False |
|
job_url |
DT_WSTR
|
nvarchar(500)
|
500 | False |
|
index |
DT_I4
|
int
|
False |
||
error |
DT_WSTR
|
nvarchar(1000)
|
1000 | False |
|
details |
DT_WSTR
|
nvarchar(4000)
|
4000 | False |
Input Columns
Label | Data Type (SSIS) | Data Type (SQL) | Length | Raw | Description |
---|---|---|---|---|---|
external_id |
DT_WSTR
|
nvarchar(500)
|
500 | False |
|
default_group_id |
DT_I8
|
bigint
|
False |
||
DT_WSTR
|
nvarchar(160)
|
160 | False |
||
alias |
DT_WSTR
|
nvarchar(255)
|
255 | False |
|
custom_role_id |
DT_I8
|
bigint
|
False |
||
details |
DT_WSTR
|
nvarchar(4000)
|
4000 | False |
|
id |
DT_I8
|
bigint
|
False |
||
photo_id |
DT_WSTR
|
nvarchar(1020)
|
1020 | False |
|
photo |
DT_WSTR
|
nvarchar(4000)
|
4000 | True |
|
name |
DT_WSTR
|
nvarchar(120)
|
120 | False |
|
suspended |
DT_BOOL
|
bit
|
False |
||
restricted_agent |
DT_BOOL
|
bit
|
False |
||
only_private_comments |
DT_BOOL
|
bit
|
False |
||
ticket_restriction |
DT_WSTR
|
nvarchar(80)
|
80 | False |
|
moderator |
DT_BOOL
|
bit
|
False |
||
time_zone |
DT_WSTR
|
nvarchar(104)
|
104 | False |
|
remote_photo_url |
DT_WSTR
|
nvarchar(4000)
|
4000 | False |
|
shared_phone_number |
DT_BOOL
|
bit
|
False |
||
notes |
DT_WSTR
|
nvarchar(4000)
|
4000 | False |
|
signature |
DT_WSTR
|
nvarchar(4000)
|
4000 | False |
|
tags |
DT_WSTR
|
nvarchar(4000)
|
4000 | True |
|
user_fields |
DT_WSTR
|
nvarchar(4000)
|
4000 | True |
|
verified |
DT_BOOL
|
bit
|
False |
||
role |
DT_WSTR
|
nvarchar(100)
|
100 | False |
|
organization_name |
DT_WSTR
|
nvarchar(200)
|
200 | False |
|
organization_id |
DT_I8
|
bigint
|
False |
||
locale |
DT_WSTR
|
nvarchar(20)
|
20 | False |
|
locale_id |
DT_I8
|
bigint
|
False |
||
phone |
DT_WSTR
|
nvarchar(80)
|
80 | False |
|
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_Bulk table using API Destination
This EndPoint belongs to Users_Bulk table, therefore you cannot work with it directly. Use this table and table-operation pair instead:
Zendesk
Users_Bulk
Insert
