Table Users
Description
No description available
Parameters
Parameter | Label | Required | Options | Description | Help | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
There are no parameters |
Supported Operations
Below section contains supported CRUD operations. Each operation is executed by some EndPoint behind the scene.Method | Supported | Reference EndPoint |
---|---|---|
SELECT | get_users | |
INSERT | post_user | |
UPDATE | put_user | |
UPSERT | upsert_user | |
DELETE | delete_user | |
LOOKUP | get_users_by_ids |
Examples
SSIS
Use Zendesk Connector in API Source component to read data or in API Destination component to read/write data:
Read from Users table using API Source

Read/write to Users table using API Destination

ODBC application
Use these SQL queries in your ODBC application data source:
Get User(s)
SELECT * FROM Users --Where Id=1234
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"}'
)
Update User
UPDATE Users
SET name='Sam Walton'
,email='sam@abc.com'
,organization_id=5397098432795
,phone='111-222-3333'
,default_group_id=114094762733
,locale='en-US'
,skip_verify_email='true' --do not send verify account email
,moderator='false'
,only_private_comments=1 --user can put only private comments
,signature='Best regards, Support Team' --Only agents and admins can have signatures
,tags='["paid","trial","solved"]'
,time_zone='America/New_York'
,role='end-user'
,external_id='zcrm_1558554000052161269'
,alias='some alias'
,details='some details'
,notes='some notes'
,remote_photo_url='https://zappysys.com/wp-content/uploads/2021/10/Slider-API-Hub-1.png'
,user_fields='{"birthdate": "1981-01-23", "gender": "M"}'
Where id=21811221397915
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"}'
)
Delete User
DELETE FROM Users Where id=21855694556443 --it doesnt delete user from system but only changes active flag
SQL Server
Use these SQL queries in SQL Server after you create a data source in Data Gateway:
Get User(s)
DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM Users --Where Id=1234';
EXEC (@MyQuery) AT [LINKED_SERVER_TO_ZENDESK_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 [LINKED_SERVER_TO_ZENDESK_IN_DATA_GATEWAY];
Update User
DECLARE @MyQuery NVARCHAR(MAX) = 'UPDATE Users
SET name=''Sam Walton''
,email=''sam@abc.com''
,organization_id=5397098432795
,phone=''111-222-3333''
,default_group_id=114094762733
,locale=''en-US''
,skip_verify_email=''true'' --do not send verify account email
,moderator=''false''
,only_private_comments=1 --user can put only private comments
,signature=''Best regards, Support Team'' --Only agents and admins can have signatures
,tags=''["paid","trial","solved"]''
,time_zone=''America/New_York''
,role=''end-user''
,external_id=''zcrm_1558554000052161269''
,alias=''some alias''
,details=''some details''
,notes=''some notes''
,remote_photo_url=''https://zappysys.com/wp-content/uploads/2021/10/Slider-API-Hub-1.png''
,user_fields=''{"birthdate": "1981-01-23", "gender": "M"}''
Where id=21811221397915';
EXEC (@MyQuery) AT [LINKED_SERVER_TO_ZENDESK_IN_DATA_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 [LINKED_SERVER_TO_ZENDESK_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 [LINKED_SERVER_TO_ZENDESK_IN_DATA_GATEWAY];