Connecting to ZohoDesk

To authenticate to ZohoDesk, and connect to your own data or to allow other users to connect to their data, you can use the OAuth standard.

Using OAuth Authentication

First, you will need to register an OAuth application with ZohoDesk. To do so, go to Zoho Developer Console, add a new Client (Server-based application) and set a valid OAuth redirect URL. Your Oauth application will be assigned a client id and a client secret. Additionally, you will need to set the relevant Domain (com, eu, in, cn etc.), defaults to com and Organization. Set Organization to Organization Id that you can find in Organizations table.

After setting the following connection properties, you are ready to connect:

AuthScheme: Set this to OAuth.
InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
OAuthClientId: Set this to the client_id that is specified in you app settings.
OAuthClientSecret: Set this to the client_secret that is specified in you app settings.
CallbackURL: Set this to the Redirect URI that is specified in your app settings
Domain: Optionally, set this in ProfileSettings to your ZohoDesk account domain
Organization: Set this in ProfileSettings to your Organizaiton Id. See Organizations table for details

Example connection string:

Profile=C:\profiles\ZohoDesk.apip;ProfileSettings='Domain=your_domain;Organization=your_organization_id';Authscheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;

Usage Examples

AccessibleOrganizations:

SELECT * FROM AccessibleOrganizations

AccountComments:

SELECT * FROM AccountComments WHERE AccountId = 'account123'

INSERT INTO AccountComments (AccountId, Content) VALUES ('account123', 'This is a new comment on the account.')

UPDATE AccountComments SET Content = 'Updated comment text.' WHERE Id = 'comment789' AND AccountId = 'account123'

DELETE FROM AccountComments WHERE Id = 'comment789' AND AccountId = 'account123'

AccountContacts:

SELECT * FROM AccountContacts WHERE AccountId = 'account123'

AccountContracts:

SELECT * FROM AccountContracts WHERE AccountId = 'account123'

AccountDeDuplicationDefaultFieldName:

SELECT * FROM AccountDeDuplicationDefaultFieldName

AccountFollowers:

SELECT * FROM AccountFollowers WHERE AccountId = 'account123'

DELETE FROM AccountFollowers WHERE Id = 'follower123' AND AccountId = 'account123'

AccountHistory:

SELECT * FROM AccountHistory WHERE AccountId = 'account123'

AccountProducts:

SELECT * FROM AccountProducts WHERE AccountId = 'account123'

AccountSearch:

SELECT * FROM AccountSearch

AccountSla:

SELECT * FROM AccountSla WHERE AccountId = 'account123'

AccountStatistics:

SELECT * FROM AccountStatistics WHERE AccountId = 'account123'

AccountTickets:

SELECT * FROM AccountTickets WHERE AccountId = 'account123'

AccountTimeEntry:

SELECT * FROM AccountTimeEntry WHERE AccountId = 'account123'

AccountTimeEntrySummation:

SELECT * FROM AccountTimeEntrySummation WHERE AccountId = 'account123'

Accounts:

SELECT * FROM Accounts

INSERT INTO Accounts (AccountName, Email, Phone, Website) VALUES ('Acme Corp', '[email protected]', '555-1234', 'https://acme.com')

UPDATE Accounts SET AccountName = 'Acme Corp Updated', Email = '[email protected]' WHERE Id = 'account123'

DELETE FROM Accounts WHERE Id = 'account123'

ActiveTimer:

SELECT * FROM ActiveTimer WHERE Module = 'module_value' AND ModuleId = 'id123'

ActivitiesSearch:

SELECT * FROM ActivitiesSearch

AgentAvailability:

SELECT * FROM AgentAvailability WHERE DepartmentId = 'dept123'

AgentAvailabilityConfiguration:

SELECT * FROM AgentAvailabilityConfiguration

AgentByEmail:

SELECT * FROM AgentByEmail WHERE EmailId = 'id123'

AgentByIds:

SELECT * FROM AgentByIds WHERE Id = 'agent147'

AgentSignatures:

SELECT * FROM AgentSignatures WHERE AgentId = 'agent123'

AgentSkills:

SELECT * FROM AgentSkills WHERE AgentId = 'agent123'

AgentTeams:

SELECT * FROM AgentTeams WHERE AgentId = '258741'

AgentTicketsCount:

SELECT * FROM AgentTicketsCount

AgentTimeEntry:

SELECT * FROM AgentTimeEntry WHERE AgentId = 'agent123'

AgentTimeEntrySummation:

SELECT * FROM AgentTimeEntrySummation WHERE AgentId = 'agent123'

Agents:

SELECT * FROM Agents

INSERT INTO Agents (LastName, firstName, EmailId, RolePermissionType, AssociatedDepartmentIds, ProfileId) VALUES ('Smith', 'John', '[email protected]', 'agent', 'dept123', 'profile456')

UPDATE Agents SET LastName = 'Smith', firstName = 'John', AssociatedDepartmentIds = 'dept123', ProfileId = 'profile456' WHERE Id = 'agent123'

AllActiveTimers:

SELECT * FROM AllActiveTimers WHERE DepartmentId = 'dept123'

ArchivedTickets:

SELECT * FROM ArchivedTickets WHERE DepartmentId = '963753'

ArticleComments:

SELECT * FROM ArticleComments WHERE ArticleId = 'article123' AND Locale = 'locale_value'

INSERT INTO ArticleComments (ContentType, Content, ArticleId, Locale) VALUES ('text/html', 'Great article, very helpful!', 'article123', 'en_US')

UPDATE ArticleComments SET Content = 'Updated comment text.' WHERE Id = 'comment789' AND ArticleId = 'article123' AND Locale = 'en_US'

DELETE FROM ArticleComments WHERE Id = 'comment789' AND ArticleId = 'article123' AND Locale = 'en_US'

ArticleFeedbacks:

SELECT * FROM ArticleFeedbacks

ArticleHistory:

SELECT * FROM ArticleHistory WHERE ArticleId = 'article123'

ArticleInsights:

SELECT * FROM ArticleInsights WHERE ArticleId = 'article123'

ArticleSearch:

SELECT * FROM ArticleSearch

ArticleTranslationSearch:

SELECT * FROM ArticleTranslationSearch WHERE SearchString = 'abc'

ArticleTranslationSearchByTag:

SELECT * FROM ArticleTranslationSearchByTag WHERE AssociatedTag = 'abc'

ArticleTranslations:

SELECT * FROM ArticleTranslations WHERE ArticleId = 'article123'

Articles:

SELECT * FROM Articles

INSERT INTO Articles (Title, Status, CategoryId, Answer) VALUES ('How to Reset Your Password', 'Published', 'cat123', 'To reset your password, click Forgot Password on the login page.')

UPDATE Articles SET Title = 'How to Reset Your Password', Status = 'Published' WHERE Id = 'article123'

DELETE FROM Articles WHERE Id = 'article123'

AssociatedTickets:

SELECT * FROM AssociatedTickets

Attachments:

SELECT * FROM Attachments WHERE ModuleId = 'id123' AND FetchModule = 'fetchmodule_value'

AutomationFeatureCount:

SELECT * FROM AutomationFeatureCount WHERE Feature = 'feature_value'

AvailableBadgeIcons:

SELECT * FROM AvailableBadgeIcons

AvailableDependencyMappings:

SELECT * FROM AvailableDependencyMappings WHERE LayoutId = 'layout456'

BadgeUsers:

SELECT * FROM BadgeUsers WHERE BadgeId = 'badge123'

Badges:

SELECT * FROM Badges

Blueprints:

SELECT * FROM Blueprints WHERE Module = 'tickets'

INSERT INTO Blueprints (Name, Type, DepartmentId, FieldId, LayoutId, Module) VALUES ('Ticket Escalation', 'TICKET', 'dept123', 'field456', 'layout789', 'TICKET')

UPDATE Blueprints SET Name = 'Updated Blueprint', Description = 'Updated blueprint workflow.' WHERE Id = 'blueprint123'

DELETE FROM Blueprints WHERE Id = 'blueprint123'

BugTickets:

SELECT * FROM BugTickets WHERE BugId = 'id123'

BulkExport:

SELECT * FROM BulkExport WHERE ExportId = 'export123'

BusinessHourRelatedRules:

SELECT * FROM BusinessHourRelatedRules WHERE BusinessHourId = 'id123'

BusinessHours:

SELECT * FROM BusinessHours

INSERT INTO BusinessHours (Name, Status, Type) VALUES ('Standard Business Hours', 'ENABLED', '24x5')

UPDATE BusinessHours SET Name = 'Updated Business Hours', Status = 'ENABLED' WHERE Id = 'bh123'

DELETE FROM BusinessHours WHERE Id = 'bh123'

CallComments:

SELECT * FROM CallComments WHERE CallId = 'call123'

INSERT INTO CallComments (Content, CallId) VALUES ('This is a comment on the call.', 'call123')

UPDATE CallComments SET Content = 'Updated call comment.' WHERE Id = 'comment789' AND CallId = 'call123'

DELETE FROM CallComments WHERE Id = 'comment789' AND CallId = 'call123'

CallSearch:

SELECT * FROM CallSearch

Calls:

SELECT * FROM Calls

INSERT INTO Calls (ContactId, Subject, Status, DepartmentId, Direction, Duration, StartTime) VALUES ('contact123', 'Support Call', 'Completed', 'dept456', 'inbound', 300, '2024-01-15T09:00:00')

UPDATE Calls SET Subject = 'Updated Support Call', Status = 'Completed', Duration = 360 WHERE Id = 'call123'

DELETE FROM Calls WHERE Id = 'call123'

Channels:

SELECT * FROM Channels

CommentHistory:

SELECT * FROM CommentHistory WHERE TicketId = 'ticket123' AND CommentId = 'comment123'

CommunityCategory:

SELECT * FROM CommunityCategory

INSERT INTO CommunityCategory (Name, Description) VALUES ('Product Feedback', 'Category for product feedback and suggestions.')

UPDATE CommunityCategory SET Name = 'Updated Category', Description = 'Updated description.' WHERE Id = 'cat123'

DELETE FROM CommunityCategory WHERE Id = 'cat123'

CommunityCategoryByPermalink:

SELECT * FROM CommunityCategoryByPermalink WHERE Permalink = 'permalink_value'

CommunityCategoryFollowers:

SELECT * FROM CommunityCategoryFollowers WHERE CategoryId = 'category123'

CommunityModeratedTopics:

SELECT * FROM CommunityModeratedTopics

CommunityModeratedUsers:

SELECT * FROM CommunityModeratedUsers

CommunityModerationComments:

SELECT * FROM CommunityModerationComments

CommunityModerationCounts:

SELECT * FROM CommunityModerationCounts

CommunityModerationTopics:

SELECT * FROM CommunityModerationTopics

CommunityMyDraftedTopics:

SELECT * FROM CommunityMyDraftedTopics

CommunityPreferences:

SELECT * FROM CommunityPreferences

CommunityTopicComments:

SELECT * FROM CommunityTopicComments WHERE TopicId = 'topic123'

INSERT INTO CommunityTopicComments (Content, TopicId) VALUES ('This is a reply to the community topic.', 'topic123')

UPDATE CommunityTopicComments SET Content = 'Updated reply content.' WHERE Id = 'comment789' AND TopicId = 'topic123'

CommunityTopicFollowerParticipantVoter:

SELECT * FROM CommunityTopicFollowerParticipantVoter WHERE TopicId = 'topic123' AND TopicType = 'topictype_value'

CommunityTopicPermalinks:

SELECT * FROM CommunityTopicPermalinks WHERE TopicId = 'topic123'

CommunityTopicTypes:

SELECT * FROM CommunityTopicTypes

CommunityTopics:

SELECT * FROM CommunityTopics WHERE Permalink = 'permalink_value'

INSERT INTO CommunityTopics (Subject, Type, CategoryId) VALUES ('Feature Request: Dark Mode', 'question', 'cat123')

UPDATE CommunityTopics SET Subject = 'Updated Topic Subject', Status = 'PUBLISHED' WHERE Id = 'topic123'

DELETE FROM CommunityTopics WHERE Id = 'topic123'

CommunityUserComments:

SELECT * FROM CommunityUserComments WHERE UserId = 'id123'

CommunityUserFollowers:

SELECT * FROM CommunityUserFollowers WHERE UserId = 'id123'

CommunityUserTopics:

SELECT * FROM CommunityUserTopics WHERE UserId = 'id123'

CommunityUsers:

SELECT * FROM CommunityUsers WHERE Id = 'id123'

ContactAccounts:

SELECT * FROM ContactAccounts WHERE ContactId = 'contact123'

ContactByIds:

SELECT * FROM ContactByIds WHERE Id = 'contact789'

ContactComments:

SELECT * FROM ContactComments WHERE ContactId = 'contact123'

INSERT INTO ContactComments (Content, ContactId) VALUES ('This is a new comment on the contact.', 'contact123')

UPDATE ContactComments SET Content = 'Updated contact comment.' WHERE Id = 'comment789' AND ContactId = 'contact123'

DELETE FROM ContactComments WHERE Id = 'comment789' AND ContactId = 'contact123'

ContactDeDuplicationDefaultFieldName:

SELECT * FROM ContactDeDuplicationDefaultFieldName

ContactFollowers:

SELECT * FROM ContactFollowers WHERE ContactId = 'contact123'

INSERT INTO ContactFollowers (Id, ContactId) VALUES ('agent123', 'contact123')

DELETE FROM ContactFollowers WHERE Id = 'agent123' AND ContactId = 'contact123'

ContactHelpCenters:

SELECT * FROM ContactHelpCenters WHERE ContactId = 'contact123'

ContactHistory:

SELECT * FROM ContactHistory WHERE ContactId = 'contact123'

ContactProducts:

SELECT * FROM ContactProducts WHERE ContactId = 'contact123'

ContactProfiles:

SELECT * FROM ContactProfiles WHERE ContactId = 'contact123'

ContactSearch:

SELECT * FROM ContactSearch

ContactStatistics:

SELECT * FROM ContactStatistics WHERE ContactId = 'contact123'

ContactTickets:

SELECT * FROM ContactTickets WHERE ContactId = 'contact123'

ContactTimeEntry:

SELECT * FROM ContactTimeEntry WHERE ContactId = 'contact123'

ContactTimeEntrySummation:

SELECT * FROM ContactTimeEntrySummation WHERE ContactId = 'contact123'

Contacts:

SELECT * FROM Contacts

INSERT INTO Contacts (LastName, FirstName, Email, Phone) VALUES ('Doe', 'Jane', '[email protected]', '555-1234')

UPDATE Contacts SET LastName = 'Doe', FirstName = 'Jane', Email = '[email protected]' WHERE Id = 'contact123'

DELETE FROM Contacts WHERE Id = 'contact123'

ContractComments:

SELECT * FROM ContractComments WHERE ContractId = 'contract123'

INSERT INTO ContractComments (Content, ContractId) VALUES ('This is a new comment on the contract.', 'contract123')

UPDATE ContractComments SET Content = 'Updated contract comment.' WHERE Id = 'comment789' AND ContractId = 'contract123'

DELETE FROM ContractComments WHERE Id = 'comment789' AND ContractId = 'contract123'

Contracts:

SELECT * FROM Contracts

INSERT INTO Contracts (ContractName, DepartmentId, OwnerId, StartDate) VALUES ('Annual Support Contract', 'dept456', 'owner789', '2024-01-01')

UPDATE Contracts SET ContractName = 'Updated Support Contract', StartDate = '2024-01-01' WHERE Id = 'contract123'

DELETE FROM Contracts WHERE Id = 'contract123'

Countries:

SELECT * FROM Countries

CreditUsers:

SELECT * FROM CreditUsers WHERE CreditId = 'id123'

Credits:

SELECT * FROM Credits

CustomFieldCount:

SELECT * FROM CustomFieldCount WHERE DepartmentId = 'dept123' AND Module = 'tickets'

CustomerHappiness:

SELECT * FROM CustomerHappiness WHERE DepartmentId = 'dept123'

CustomerHappinessContent:

SELECT * FROM CustomerHappinessContent WHERE ThreadId = 'id123'

CustomerHappinessLinkHolder:

SELECT * FROM CustomerHappinessLinkHolder WHERE DepartmentId = 'dept123'

DashboardResponseCount:

SELECT * FROM DashboardResponseCount WHERE GroupBy = 'groupby_value' AND Duration = 'duration_value'

DashboardResponseTime:

SELECT * FROM DashboardResponseTime WHERE GroupBy = 'groupby_value' AND IsFirstResponse = 'isfirstresponse_value' AND Duration = 'duration_value'

DashboardTickets:

SELECT * FROM DashboardTickets WHERE TicketType = 'tickettype_value' AND GroupBy = 'groupby_value' AND Duration = 'duration_value'

DashboardTicketsResolutionTime:

SELECT * FROM DashboardTicketsResolutionTime WHERE GroupBy = 'groupby_value' AND Duration = 'duration_value'

DataSharingRules:

SELECT * FROM DataSharingRules

DepartmentAgents:

SELECT * FROM DepartmentAgents WHERE DepartmentId = 'dept123'

DepartmentByIds:

SELECT * FROM DepartmentByIds WHERE Id = '123456'

DepartmentCheckExists:

SELECT * FROM DepartmentCheckExists WHERE DepartmentName = 'testname'

DepartmentMailConfigurations:

SELECT * FROM DepartmentMailConfigurations WHERE DepartmentId = 'dept123'

DepartmentTeams:

SELECT * FROM DepartmentTeams WHERE DepartmentId = '654987'

Departments:

SELECT * FROM Departments

INSERT INTO Departments (Name, AssociatedAgentIds) VALUES ('Technical Support', 'agent123')

UPDATE Departments SET Name = 'Updated Technical Support' WHERE Id = 'dept123'

DependencyMappings:

SELECT * FROM DependencyMappings WHERE LayoutId = 'layout456'

Domains:

SELECT * FROM Domains

DuplicateAccountDetails:

SELECT * FROM DuplicateAccountDetails WHERE FieldName = 'fieldname_value' AND FieldValue = 'fieldvalue_value'

EmailFailureAlerts:

SELECT * FROM EmailFailureAlerts WHERE DepartmentId = '456789'

EventComments:

SELECT * FROM EventComments WHERE EventId = 'id123'

INSERT INTO EventComments (Content, EventId) VALUES ('This is a comment on the event.', 'event123')

UPDATE EventComments SET Content = 'Updated event comment.' WHERE Id = 'comment789' AND EventId = 'event123'

DELETE FROM EventComments WHERE Id = 'comment789' AND EventId = 'event123'

EventSearch:

SELECT * FROM EventSearch

Events:

SELECT * FROM Events

INSERT INTO Events (Subject, ContactId, Duration, DepartmentId, StartTime) VALUES ('Follow-up Call', 'contact123', 30, 'dept456', '2024-01-15T10:00:00.000+0000')

UPDATE Events SET Subject = 'Updated Follow-up Call', StartTime = '2024-01-15T10:00:00.000+0000' WHERE Id = 'event123'

DELETE FROM Events WHERE Id = 'event123'

Followers:

SELECT * FROM Followers WHERE ModuleName = 'modulename_value'

GroupDuplicateValues:

SELECT * FROM GroupDuplicateValues WHERE EntityType = 'entitytype_value'

GroupUsers:

SELECT * FROM GroupUsers WHERE GroupId = 'group123'

DELETE FROM GroupUsers WHERE Id = 'user123' AND GroupId = 'group456'

Groups:

SELECT * FROM Groups

INSERT INTO Groups (Name, HelpCenterId, Description) VALUES ('VIP Customers', 'hc123', 'Group for VIP customers.')

UPDATE Groups SET Name = 'Updated VIP Customers', Status = 'active' WHERE Id = 'group123'

DELETE FROM Groups WHERE Id = 'group123'

HelpCenters:

SELECT * FROM HelpCenters

HolidayList:

SELECT * FROM HolidayList

IMCannedMessages:

SELECT * FROM IMCannedMessages WHERE DepartmentId = '741159'

IMChannels:

SELECT * FROM IMChannels

IMMetricSessionTimeSeries:

SELECT * FROM IMMetricSessionTimeSeries WHERE Duration = 'duration_value' AND Granularity = 'granularity_value' AND Dimension = 'dimension_value' AND DimensionValue = 'dimensionvalue_value'

IMSessions:

SELECT * FROM IMSessions

Imports:

SELECT * FROM Imports WHERE Id = 'id123'

InvoiceTickets:

SELECT * FROM InvoiceTickets WHERE InvoiceId = 'id123'

JiraIssueTickets:

SELECT * FROM JiraIssueTickets WHERE IssueId = 'id123'

KbCategoryRepositionArticles:

SELECT * FROM KbCategoryRepositionArticles WHERE CategoryId = 'category123'

KbRootCategories:

SELECT * FROM KbRootCategories

INSERT INTO KbRootCategories (Name, Status, Description, ArticleViewType, ModerationType, IsReviewEnabled, Visibility, LogoId) VALUES ('Technical Documentation', 'PUBLISHED', 'Root category for technical documentation.', 'PUBLIC', 'NONE', true, 'ALL', 'logo123')

KbRootCategoriesCategoryTree:

SELECT * FROM KbRootCategoriesCategoryTree WHERE Id = 'id123'

KbRootCategoriesReviewOwners:

SELECT * FROM KbRootCategoriesReviewOwners WHERE RootCategoryId = 'id123'

KbSections:

SELECT * FROM KbSections WHERE SectionId = 'secid1234'

LabelUsers:

SELECT * FROM LabelUsers WHERE LabelId = 'label123'

DELETE FROM LabelUsers WHERE Id = 'user123' AND LabelId = 'label456'

Labels:

SELECT * FROM Labels

INSERT INTO Labels (Name, HelpCenterId) VALUES ('Bug Report', 'hc123')

UPDATE Labels SET Name = 'Updated Bug Report' WHERE Id = 'label123'

DELETE FROM Labels WHERE Id = 'label123'

Languages:

SELECT * FROM Languages

LastAccessedView:

SELECT * FROM LastAccessedView WHERE FetchModule = 'tickets'

LayoutProfiles:

SELECT * FROM LayoutProfiles WHERE LayoutId = 'layout123'

LayoutRuleCriteriaFields:

SELECT * FROM LayoutRuleCriteriaFields WHERE LayoutId = 'layout123'

LayoutRules:

SELECT * FROM LayoutRules WHERE LayoutId = 'layout123'

Layouts:

SELECT * FROM Layouts WHERE Module = 'module_value'

INSERT INTO Layouts (LayoutDisplayname, LayoutName, DepartmentId, IsDefaultLayout, Module, Sections, SkipDepartmentAccessValidation) VALUES ('Default Ticket Layout', 'DefaultTicket', 'dept123', true, 'tickets', '[{"name":"Details","fields":[]}]', false)

UPDATE Layouts SET LayoutDisplayname = 'Updated Ticket Layout', IsDefaultLayout = true, Sections = '[{"name":"Details","fields":[]}]' WHERE Id = 'layout123'

Levels:

SELECT * FROM Levels

LightAgentProfile:

SELECT * FROM LightAgentProfile

MailConfigurations:

SELECT * FROM MailConfigurations

MailReplyAddress:

SELECT * FROM MailReplyAddress WHERE DepartmentId = '789456'

MetricsAgents:

SELECT * FROM MetricsAgents WHERE Duration = 'TODAY' AND Attributegroup = 'RESPONSIVENESS'  AND Attributes = 'AVG_RESPONSE_TIME'

MyActiveTimers:

SELECT * FROM MyActiveTimers WHERE DepartmentId = 'dept123'

MyForm:

SELECT * FROM MyForm

MyModules:

SELECT * FROM MyModules

MyPendingApprovals:

SELECT * FROM MyPendingApprovals WHERE DepartmentId = '753357'

MyPreferences:

SELECT * FROM MyPreferences

MyProfile:

SELECT * FROM MyProfile

MyProfilePermissions:

SELECT * FROM MyProfilePermissions

Myinfo:

SELECT * FROM Myinfo

OfflineAgents:

SELECT * FROM OfflineAgents WHERE DepartmentId = 'dept123'

OnlineAgents:

SELECT * FROM OnlineAgents WHERE DepartmentId = '357741'

OrganizationFieldCriteriaReferences:

SELECT * FROM OrganizationFieldCriteriaReferences WHERE FieldId = 'id123' AND FilterFeatureType = 'filterfeaturetype_value'

OrganizationFieldPermissions:

SELECT * FROM OrganizationFieldPermissions WHERE FieldId = 'id123'

OrganizationFields:

SELECT * FROM OrganizationFields WHERE FetchModule = 'tickets'

OrganizationModules:

SELECT * FROM OrganizationModules

Organizations:

SELECT * FROM Organizations

PermalinkAvailability:

SELECT * FROM PermalinkAvailability WHERE Permalink = 'custom-section'

PersonalRole:

SELECT * FROM PersonalRole

ProductAccounts:

SELECT * FROM ProductAccounts WHERE ProductId = 'product123'

ProductContacts:

SELECT * FROM ProductContacts WHERE ProductId = 'product123'

ProductSearch:

SELECT * FROM ProductSearch

ProductSearchDuplicates:

SELECT * FROM ProductSearchDuplicates WHERE ProductName = 'Premium Support'

ProductTickets:

SELECT * FROM ProductTickets WHERE ProductId = 'product123'

Products:

SELECT * FROM Products

INSERT INTO Products (ProductName, DepartmentIds) VALUES ('Enterprise Support Plan', 'dept123')

UPDATE Products SET ProductName = 'Updated Enterprise Support Plan', DepartmentIds = 'dept123' WHERE Id = 'product123'

DELETE FROM Products WHERE Id = 'product123'

ProfileAgents:

SELECT * FROM ProfileAgents WHERE ProfileId = 'id123'

Profiles:

SELECT * FROM Profiles

UPDATE Profiles SET Name = 'Updated Profile Name', Description = 'Updated profile description.' WHERE Id = 'profile123'

DELETE FROM Profiles WHERE Id = 'profile123' AND TransferToProfileId = 'profile456'

RecycleBin:

SELECT * FROM RecycleBin

RoleAgents:

SELECT * FROM RoleAgents WHERE RoleId = 'role123'

RoleByIds:

SELECT * FROM RoleByIds WHERE Id = 'role456'

RoleTeams:

SELECT * FROM RoleTeams WHERE RoleId = '147963'

Roles:

SELECT * FROM Roles

INSERT INTO Roles (Name, IsDataSharedWithPeers) VALUES ('Senior Support Agent', true)

UPDATE Roles SET Name = 'Updated Senior Support Agent' WHERE Id = 'role123'

DELETE FROM Roles WHERE Id = 'role123' AND TransferToRoleId = 'role456'

RoutingPreferences:

SELECT * FROM RoutingPreferences WHERE DepartmentId = '159741'

Search:

SELECT * FROM Search

SkillConfiguration:

SELECT * FROM SkillConfiguration WHERE DepartmentId = '369159'

SkillCriteriaFields:

SELECT * FROM SkillCriteriaFields WHERE DepartmentId = '357159' AND FetchModule = 'tickets'

SkillRelatedRules:

SELECT * FROM SkillRelatedRules WHERE Skillid = 'skillid_value'

SkillTypes:

SELECT * FROM SkillTypes

Skills:

SELECT * FROM Skills WHERE DepartmentId = '741852'

INSERT INTO Skills (Name, Status, SkillTypeId) VALUES ('Customer Communication', 'ACTIVE', 'skilltype123')

UPDATE Skills SET Name = 'Customer Communication', Status = 'ACTIVE' WHERE Id = 'skill123'

DELETE FROM Skills WHERE Id = 'skill123'

StandardLayoutFormat:

SELECT * FROM StandardLayoutFormat WHERE FetchModule = 'tickets'

StarredViews:

SELECT * FROM StarredViews

SubjectAccessRequestFieldsAndConditions:

SELECT * FROM SubjectAccessRequestFieldsAndConditions WHERE FetchModule = 'tickets'

SubjectAccessRequests:

SELECT * FROM SubjectAccessRequests

SupportEmailDomain:

SELECT * FROM SupportEmailDomain

SupportPlans:

SELECT * FROM SupportPlans WHERE DepartmentId = '951147'

SupportedEmailAddress:

SELECT * FROM SupportedEmailAddress WHERE DepartmentId = '357963'

TagSearch:

SELECT * FROM TagSearch WHERE DepartmentId = '357963'

TagTickets:

SELECT * FROM TagTickets WHERE TagId = 'id123'

TaskComments:

SELECT * FROM TaskComments WHERE TaskId = 'task123'

INSERT INTO TaskComments (Content, TaskId) VALUES ('This is a comment on the task.', 'task123')

UPDATE TaskComments SET Content = 'Updated task comment.' WHERE Id = 'comment789' AND TaskId = 'task123'

DELETE FROM TaskComments WHERE Id = 'comment789' AND TaskId = 'task123'

TaskSearch:

SELECT * FROM TaskSearch

TaskTimeEntry:

SELECT * FROM TaskTimeEntry WHERE TaskId = 'task123'

INSERT INTO TaskTimeEntry (ExecutedTime, TaskId) VALUES ('2024-01-15T09:00:00.000+0000', 'task123')

UPDATE TaskTimeEntry SET Description = 'Updated time entry description.', HoursSpent = 2 WHERE Id = 'entry123' AND TaskId = 'task123'

DELETE FROM TaskTimeEntry WHERE Id = 'entry123' AND TaskId = 'task123'

TaskTimeEntrySummation:

SELECT * FROM TaskTimeEntrySummation WHERE TaskId = 'task123'

Tasks:

SELECT * FROM Tasks

INSERT INTO Tasks (Subject, DepartmentId) VALUES ('Follow up with customer', 'dept456')

UPDATE Tasks SET Subject = 'Updated task subject' WHERE Id = 'task123' AND TicketId = 'ticket123'

DELETE FROM Tasks WHERE Id = 'task123'

TeamAssociables:

SELECT * FROM TeamAssociables WHERE TeamId = '1234'

TeamMembers:

SELECT * FROM TeamMembers

Teams:

SELECT * FROM Teams

INSERT INTO Teams (Name, DepartmentId) VALUES ('Support Team Alpha', 'dept123')

UPDATE Teams SET Name = 'Updated Support Team Alpha' WHERE Id = 'team123'

TemplateFolders:

SELECT * FROM TemplateFolders WHERE departmentId = 'id123'

TemplatePlaceholders:

SELECT * FROM TemplatePlaceholders WHERE departmentId = 'id123'

Templates:

SELECT * FROM Templates WHERE departmentId = 'id123'

INSERT INTO Templates (Subject, TemplateName, ContentType, RecordType, DepartmentId, FolderId, FromId) VALUES ('Welcome Email', 'WelcomeEmailTemplate', 'richtext', 'tickets', 'dept123', 'folder456', 'from789')

UPDATE Templates SET Subject = 'Updated Welcome Email', TemplateName = 'UpdatedWelcomeTemplate' WHERE Id = 'template123'

DELETE FROM Templates WHERE Id = 'template123'

ThreadOriginalContent:

SELECT * FROM ThreadOriginalContent WHERE TicketId = 'ticket123' AND ThreadId = 'id123'

TicketActivities:

SELECT * FROM TicketActivities WHERE TicketId = 'ticket123'

TicketApprovals:

SELECT * FROM TicketApprovals WHERE TicketId = 'ticket123'

TicketArticleSuggestion:

SELECT * FROM TicketArticleSuggestion WHERE TicketId = 'ticket123'

TicketBlueprint:

SELECT * FROM TicketBlueprint WHERE TicketId = 'ticket123'

TicketCalls:

SELECT * FROM TicketCalls WHERE TicketId = 'ticket123'

TicketComments:

SELECT * FROM TicketComments WHERE TicketId = 'ticket123'

INSERT INTO TicketComments (Content, TicketId) VALUES ('This is a new comment on the ticket.', 'ticket123')

UPDATE TicketComments SET Content = 'Updated ticket comment.' WHERE Id = 'comment789' AND TicketId = 'ticket123'

DELETE FROM TicketComments WHERE Id = 'comment789' AND TicketId = 'ticket123'

TicketConversations:

SELECT * FROM TicketConversations WHERE TicketId = 'ticket123'

TicketCountByFieldValues:

SELECT * FROM TicketCountByFieldValues WHERE Field = 'field_value'

TicketEvents:

SELECT * FROM TicketEvents WHERE TicketId = 'ticket123'

TicketFollowers:

SELECT * FROM TicketFollowers WHERE TicketId = 'ticket123'

INSERT INTO TicketFollowers (Id, TicketId) VALUES ('agent123', 'ticket123')

DELETE FROM TicketFollowers WHERE Id = 'agent123' AND TicketId = 'ticket123'

TicketHistory:

SELECT * FROM TicketHistory WHERE TicketId = 'ticket123'

TicketLatestThread:

SELECT * FROM TicketLatestThread WHERE TicketId = 'ticket123'

TicketMetrics:

SELECT * FROM TicketMetrics WHERE TicketId = 'ticket123'

TicketPins:

SELECT * FROM TicketPins WHERE TicketId = 'ticket123'

TicketResolution:

SELECT * FROM TicketResolution WHERE TicketId = 'ticket123'

TicketResolutionHistory:

SELECT * FROM TicketResolutionHistory WHERE TicketId = 'ticket123'

TicketSearch:

SELECT * FROM TicketSearch

TicketTags:

SELECT * FROM TicketTags WHERE TicketId = 'ticket123'

TicketTasks:

SELECT * FROM TicketTasks WHERE TicketId = 'ticket123'

TicketTemplates:

SELECT * FROM TicketTemplates WHERE DepartmentId = '357963'

INSERT INTO TicketTemplates (TicketTemplateName, TicketTemplateValuesSubject, TicketTemplateValuesDepartmentId) VALUES ('New Customer Ticket', 'New Customer Issue', 'dept123')

UPDATE TicketTemplates SET TicketTemplateName = 'Updated Customer Ticket', TicketTemplateValuesSubject = 'Updated Customer Issue' WHERE Id = 'template123'

DELETE FROM TicketTemplates WHERE Id = 'template123'

TicketThreads:

SELECT * FROM TicketThreads WHERE TicketId = 'ticket123'

TicketTimeEntry:

SELECT * FROM TicketTimeEntry WHERE TicketId = 'ticket123'

INSERT INTO TicketTimeEntry (ExecutedTime, TicketId) VALUES ('2024-01-15T09:00:00.000+0000', 'ticket123')

UPDATE TicketTimeEntry SET Description = 'Updated time entry description.', HoursSpent = 2 WHERE Id = 'entry123' AND TicketId = 'ticket123'

DELETE FROM TicketTimeEntry WHERE Id = 'entry123' AND TicketId = 'ticket123'

TicketTimeEntryByBillingType:

SELECT * FROM TicketTimeEntryByBillingType WHERE TicketId = 'ticket123'

TicketTimeEntrySummation:

SELECT * FROM TicketTimeEntrySummation WHERE TicketId = 'ticket123'

TicketTransitionForm:

SELECT * FROM TicketTransitionForm WHERE TicketId = 'ticket123' AND TransitionId = 'id123'

Tickets:

SELECT * FROM Tickets

INSERT INTO Tickets (Subject, ContactId, DepartmentId) VALUES ('Unable to login to account', 'contact123', 'dept456')

UPDATE Tickets SET Subject = 'Unable to login to account - Updated', DepartmentId = 'dept456' WHERE Id = 'ticket123'

DELETE FROM Tickets WHERE Id = 'ticket123'

TimeTrackHistory:

SELECT * FROM TimeTrackHistory WHERE DepartmentId = '357963'

TimeTrackSettings:

SELECT * FROM TimeTrackSettings WHERE DepartmentId = '357963'

TimeZones:

SELECT * FROM TimeZones

Timer:

SELECT * FROM Timer WHERE Module = 'module_value' AND ModuleId = 'id123'

TranslationAttachments:

SELECT * FROM TranslationAttachments WHERE ArticleId = 'article123' AND Locale = 'locale_value'

TranslationComments:

SELECT * FROM TranslationComments WHERE ArticleId = 'article123' AND Locale = 'locale_value'

INSERT INTO TranslationComments (ContentType, Content, IsPublic, ArticleId, Locale) VALUES ('html', 'This is a comment on the translation.', true, 'article123', 'en_US')

UPDATE TranslationComments SET Content = 'Updated translation comment.', IsPublic = true WHERE Id = 'comment789' AND ArticleId = 'article123' AND Locale = 'en_US'

TranslationFeedbacks:

SELECT * FROM TranslationFeedbacks WHERE ArticleId = 'article123' AND Locale = 'locale_value'

TranslationPermalinks:

SELECT * FROM TranslationPermalinks WHERE ArticleId = 'article123' AND Locale = 'locale_value'

UserBadges:

SELECT * FROM UserBadges WHERE UserId = 'id123'

UserGroups:

SELECT * FROM UserGroups WHERE UserId = 'id123'

UserLabels:

SELECT * FROM UserLabels WHERE UserId = 'id123'

Users:

SELECT * FROM Users

ValidationRuleCriteriaFields:

SELECT * FROM ValidationRuleCriteriaFields WHERE LayoutId = 'layout123'

ValidationRules:

SELECT * FROM ValidationRules WHERE LayoutId = 'layout123'

INSERT INTO ValidationRules (FieldName, FieldConditions, LayoutId) VALUES ('subject', '[{"fieldName":"subject","operator":"isEmpty"}]', 'layout123')

UPDATE ValidationRules SET FieldConditions = '[{"fieldName":"subject","operator":"isEmpty"}]' WHERE Id = 'rule123' AND LayoutId = 'layout123'

DELETE FROM ValidationRules WHERE Id = 'rule123' AND LayoutId = 'layout123'

Views:

SELECT * FROM Views WHERE FetchModule = 'tickets'

VoterTrend:

SELECT * FROM VoterTrend WHERE TopicId = 'topic123'

ZohoFinanceEstimates:

SELECT * FROM ZohoFinanceEstimates WHERE Financeservice = 'financeservice_value'

ZohoFinanceInvoices:

SELECT * FROM ZohoFinanceInvoices WHERE FinanceService = 'financeservice_value'

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.

Property	Description
AuthScheme	The scheme used for authentication. Accepted entries are None or OAuth. Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT, OAUTH_PASSWORD
CallbackURL	Identifies the URL users return to after authenticating to API via OAuth (Custom OAuth applications only).
Domain	Determines the domain where authentication calls will be sent to. Allowed values are: MIXPANEL, EU.MIXPANEL, IN.MIXPANEL, .COM, .EU, .COM.AU, .IN, COM, EU, COM.AU, IN, JP, COM.CN, CA, SA, .COM.CN, .JP, .CA, .SA
InitiateOAuth	Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working. Allowed values are: OFF, REFRESH, GETANDREFRESH
OAuthAccessToken	Specifies the OAuth access token used to authenticate requests to the data source. This token is issued by the authorization server after a successful OAuth exchange.
OAuthClientId	Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
OAuthExpiresIn	Specifies the duration in seconds, of an OAuth Access Token's lifetime. The token can be reissued to keep access alive as long as the user keeps working.
OAuthRefreshToken	Specifies the OAuth refresh token used to request a new access token after the original has expired.
OAuthSettingsLocation	Specifies the location of the settings file where OAuth values are saved.
OAuthTokenTimestamp	Displays a Unix epoch timestamp in milliseconds that shows how long ago the current access token was created.
OAuthVerifier	Specifies a verifier code returned from the OAuthAuthorizationURL . Used when authenticating to OAuth on a headless server, where a browser can't be launched. Requires both OAuthSettingsLocation and OAuthVerifier to be set.
Organization	The Id associated with the specific Zoho Desk organization you wish to connect to. Get it from Organizations table.
Scope	Scope(s) to use when authenticating, that control access to specific information.