This page provides a guide to Establishing a Connection to Zendesk in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.

Connecting to Zendesk

Establishing a Connection shows how to authenticate to Zendesk and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from Zendesk through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.

Connect to Zendesk by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.

Connecting to Zendesk

To connect to Zendesk, set the URL (Zendesk Support URL), using the format https://{subdomain}.zendesk.com. Once connected, user authenticate as described in the following section.

In addition, users who work with archived data for the TicketMetrics table must set the UseIncrementalAPI property to True.

Authenticating to Zendesk

Zendesk supports two types of authentication, depending on whether the user is connecting directly to their own local data (basic authentication) or connecting to shared data via a browser (OAuth authentication).

Basic Authentication

To use Basic authentication, specify an email address and either a Password or an ApiToken. Set User to your email address, and then use the Zendesk Support admin interface to do the following:

1. Enable password access.
2. Set AuthScheme to Basic while using APIToken Authentication.
3. At Admin > Channels > API, manage API tokens. Only one token can be active at a time. Deleting a token deactivates it permanently.

OAuth Authentication

Zendesk supports OAuth authentication for all instances where the user is accessing shared data via the network. This means that, regardless of whether authentication originates at the Web, a Desktop, or a Headless Server, you must set AuthScheme to OAuth, and you must create a custom OAuth application.

The following subsections describe how to authenticate to Zendesk from three common authentication flows:

• Desktop: a connection to a server on the user's local machine, frequently used for testing and prototyping.
• Web: access to data via a shared website.
• Headless Server: a dedicated computer that provides services to other computers and their users, which is configured to operate without a monitor and keyboard.

For information about how to create a custom OAuth application, see Creating a Custom OAuth Application. For a complete list of connection string properties available in Zendesk, see Connection.

Automatic refresh of the OAuth access token:

To have the Cloud automatically refresh the OAuth access token, do the following:

1. Before connecting to data for the first time, set the following connection parameters:
   • InitiateOAuth = REFRESH.
   • OAuthClientId = the client Id in your application settings.
   • OAuthClientSecret = the client secret in your application settings.
   • OAuthAccessToken = the access token returned by GetOAuthAccessToken.
   • OAuthSettingsLocation = the path where you want the Cloud to save the OAuth values, which persist across connections.
2. On subsequent data connections, set the following:
   • InitiateOAuth
   • OAuthSettingsLocation

Customizing the SSL Configuration

By default, the Cloud attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store. To specify another certificate, see the SSLServerCert property for the available formats to do so.

Connecting Through a Firewall or Proxy

HTTP Proxies

To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.

In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.

Other Proxies

Set the following properties:

• To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
• To tunnel the connection, set FirewallType to TUNNEL.
• To authenticate, specify FirewallUser and FirewallPassword.
• To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

Customizing the SSL Configuration

By default, the Cloud attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Connecting Through a Firewall or Proxy

HTTP Proxies

To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.

In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.

Other Proxies

Set the following properties:

• To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
• To tunnel the connection, set FirewallType to TUNNEL.
• To authenticate, specify FirewallUser and FirewallPassword.
• To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

The CData Cloud models entities in the Zendesk API as tables, views, and stored procedures. The Tickets schema dynamically reflects changes in custom fields. Other entities are defined in schema files, which are simple, text-based configuration files.

Using Query Processing

The Cloud offloads as much of the SELECT statement processing as possible to the Zendesk APIs and then processes the rest of the query within the Cloud. The following sections document API limitations and requirements.

Stored Procedures

Stored Procedures are function-like interfaces to the data source. They can be used to search, update, and modify information in the data source.

The Cloud models the data in Zendesk as a list of tables in a relational database that can be queried using standard SQL statements.

CData Cloud - Zendesk Tables

Name	Description
AccountSettings	Query and update Account Settings in Zendesk.
ArticleAttachments	Query and Delete Acticle Attachment in Zendesk.
ArticleComments	Create, Update, Delete and Query the Article Comments in Zendesk.
ArticleLabels	Create, delete, and query Article Lables in Zendesk.
Articles	Create, Update, Archive and query Acticles in Zendesk.
Attributes	Create, Update, Delete and Query the Attributes in Zendesk. An attribute in Zendesk refers to a skill type. Skill types are categories of skills.
AttributeValues	Create, Update, Delete and Query the Attribute Values in Zendesk. An attribute value in this API refers to a skill. Skills are associated with an agent and determine the agent's suitability to solve a ticket.
Automations	Create, update, delete, and query Automations in Zendesk.
Bookmarks	Create, Delete and Query the Bookmarks in Zendesk.
Brands	Create, delete, update, and query Brands in Zendesk.
Categories	Create, update, delete, and query Categories in Zendesk.
ContentSubscriptions	Create, Update, Delete and Query the Content Subscriptions in Zendesk. Users can subscribe to sections, articles, community posts, and community topics.
ContentTags	Create, Update, Delete and Query the Content Tags in Zendesk.
CustomAgentRoles	Create, Update, Delete and Query CustomAgentRoles in Zendesk.
CustomObjects	Create, delete, update, and query Custom Objects in Zendesk.
CustomTicketStatuses	Create, update, and query custom ticket statuses in zendesk.
GroupMemberships	Create, delete, and query Group Memberships in Zendesk.
Groups	Create, update, delete, and query Groups in Zendesk.
Holidays	Create, update, delete, and query Schedules in Zendesk.
JiraLinks	View and create links between your Jira and Zendesk instances.
Macros	Create, update, delete, and query Macros in Zendesk.
ManagementPermissionGroups	Create, Update, Delete and Query the Management Permission Groups in Zendesk. A management permission group defines which agents can create, update, archive, and publish articles. It consists of a set of privileges, each of which is mapped to a user segment. Agents receive whichever privileges are associated with the user segments they belong to.
OrganizationFields	Create, update, delete, and query Organization Fields in Zendesk.
OrganizationMemberships	Create, delete, and query Organization Memberships in Zendesk.
Organizations	Create, delete, update, and query Organizations in Zendesk.
OrganizationSubscriptions	Create, delete, and query Organization Subscriptions in Zendesk.
PostComments	Query, Insert, Update and Delete PostComments in Zendesk.
Posts	Queries, Inserts, Updates, and Deletes Posts in Zendesk.
SatisfactionRatings	Create and query Requests in Zendesk.
Schedules	Create, update, delete and query Schedules in Zendesk.
Sections	Create, update, delete, and query Sections in Zendesk.
Sessions	Query and delete Sessions in Zendesk.
SharingAgreements	Create, update, delete, and query SharingAgreements in Zendesk.
SideConversations	Create, update and query Side Conversations in Zendesk.
SlaPolicies	Create, update, delete, and query SlaPolicies in Zendesk.
SupportAddresses	Create, update, delete, and query Support Addresses in Zendesk.
SuspendedTickets	Query and delete Suspended Tickets in Zendesk.
TicketAudits	Query TicketAudits in Zendesk.
TicketComments	Query TicketComments belonging to a specified ticket in Zendesk.
TicketEvents	Query TicketEvents in Zendesk.
TicketFields	Create, update, delete, and query TicketFields in Zendesk.
TicketForms	Create, update, delete, and query Ticket Forms in Zendesk.
TicketMetricEvents	Queries TicketMetricEvents in Zendesk.
TicketMetrics	Query TicketMetrics in Zendesk.
Tickets	Create, update, delete, and query Tickets.
TicketSkips	Create and Query the TicketSkips in Zendesk. A skip is a record of when an agent skips over a ticket without responding to the end user. Skips are typically recorded while a play-only agent is in Guided mode.
Tickets_Collaborators	The Collaborator id of users currently CC'ed on the ticket.
Tickets_Followers	The ids of agents currently following the ticket
Tickets_Followups	The ids of the followups created from ticket.
Tickets_Macros	List of macros to be recorded in the ticket audit.
Tickets_SatisfactionRatings	The satisfaction rating of the ticket, if it exists, or the state of satisfaction.
Tickets_SharingAgreements	The sharing agreements used for ticket.
Tickets_Tags	The tags applied to the ticket
Tickets_Viasources	List ViaSources for the Ticket.
Topics	Queries, Inserts, Updates, and Deletes Topics in Zendesk.
Translations	Create, Update, Delete and Query the Translations in Zendesk.
TriggerCategories	Create, update, delete, and query Trigger Categories in Zendesk.
Triggers	Create, update, delete, and query Triggers in Zendesk.
UserFields	Create, update, delete, and query User Fields.
UserIdentities	Creates, updates, deletes, and queries User Identities.
Users	Create, update, delete, and query Users in Zendesk.
UserSegments	Create, Update, Delete and Query the User Segments in Zendesk. A user segment defines who can view the content of a section or topic.
Views	Create, Update, Delete and Query Views in Zendesk.
Votes	Create, Delete and Query the Votes in Zendesk. Votes represents positive and negative opinions of users about articles, article comments, posts or post comments.

Query and update Account Settings in Zendesk.

Table Specific Information

Select

The Cloud executes all filters on this table client side.

Update

All fields that are not readonly (readonly="false" in the table) can be updated. Allowed for admins. For example:

UPDATE AccountSettings SET ActiveFeaturesCustomerSatisfaction = true

Columns

Name	Type	ReadOnly	References	Description
BrandingHeaderColor	String	False		HEX of the header color.
BrandingPageBackgroundColor	String	True		HEX of the page background color.
BrandingTabBackgroundColor	String	True		HEX of tab background color.
BrandingTextColor	String	True		HEX of the text color, usually matched to contrast well with header_color.
BrandingHeaderLogoUrl	String	True		The URL for the custom header logo.
BrandingFaviconUrl	String	True		The URL for the custom favicon.
AppsUse	Boolean	True		The account can use apps.
AppsCreatePrivate	Boolean	True		The account can create private apps.
TicketsCommentsPublicByDefault	Boolean	True		Comments from agents are public by default.
TicketsIsFirstCommentPrivateEnabled	Boolean	True		Allow first comment on tickets to be private.
TicketsListNewestCommentsFirst	Boolean	True		When viewing a ticket, show the newest comments and events first.
TicketsCollaboration	Boolean	True		CCs may be added to a ticket.
TicketsPrivateAttachments	Boolean	True		Users must login to access attachments.
TicketsEmailAttachments	Boolean	True		Attachments should be sent as real attachments when under the size limit.
TicketsAgentCollision	Boolean	True		Clients should provide an indicator when a ticket is being viewed by another agent.
TicketsMaximumPersonalViewsToList	Integer	True		Maximum number of personal Views clients should display in menus.
TicketsTagging	Boolean	True		Tickets may be tagged.
TicketsMarkdownTicketComments	Boolean	True		Whether agent comments should be processed with Markdown.
TicketsEmojiAutocompletion	Boolean	True		Whether agent comments should allow for Emoji rendering.
TicketsAgentTicketDeletion	Boolean	False		Whether agents can delete tickets.
ChatEnabled	Boolean	True		Chat is enabled.
ChatMaximumRequests	Integer	True		The maximum number of chat requests an agent may handle at one time.
ChatWelcomeMessage	String	True		The message automatically sent to end-users when they begin chatting with an agent.
TwitterShortenUrl	String	True		Possible values: always, optional, never.
GSuiteHasGoogleApps	Boolean	True		Whether has google apps.
GSuiteHasGoogleAppsAdmin	Boolean	False		Account has at least one G Suite admin.
VoiceEnabled	Boolean	True		Whether Voice is enabled.
VoiceMaintenance	Boolean	True		.
VoiceLogging	Boolean	True		.
VoiceOutboundEnabled	Boolean	True		.
VoiceAgentConfirmationWhenForwarding	Boolean	True		.
VoiceAgentWrapUpAfterCalls	Boolean	True		.
VoiceMaximumQueueSize	Integer	True		.
VoiceMaximumQueueWaitTime	Integer	True		.
VoiceOnlyDuringBusinessHours	Boolean	True		.
VoiceRecordingsPublic	Boolean	True		.
VocieUkMobileForwarding	Boolean	True		.
UsersTagging	Boolean	True		Users may be tagged.
UsersTimeZoneSelection	Boolean	True		Whether user can view time zone for profile.
UsersLanguageSelection	Boolean	True		Whether to display language drop down for a user.
UsersAgentCreatedWelcomeEmails	Boolean	True		Whether a user created by an agent receives a welcome email.
UsersEndUserPhoneNumberValidation	Boolean	False		Whether a user's phone number is validated.
GooddataAdvancedAnalytics_Enabled	Boolean	True		GoodData Advanced Analytics is enabled.
BrandsDefaultBrandId	Long	False		The id of the brand that is assigned to tickets by default.
BrandsRequireBrandOnNewTickets	Boolean	True		Require agents to select a brand before saving tickets.
StatisticsForum	Boolean	True		Allow users to view forum statistics.
StatisticsSearch	Boolean	True		Allow users to view search statistics.
BillingBackend	String	True		Backend Billing system either internal or zuora.
ActiveFeaturesOnHoldStatus	Boolean	True		Account can use status hold.
ActiveFeaturesUserTagging	Boolean	True		Enable user tags.
ActiveFeaturesTicketTagging	Boolean	True		Allow tagging tickets.
ActiveFeaturesTopicSuggestion	Boolean	True		Allow topic suggestions in tickets.
ActiveFeaturesVoice	Boolean	True		Voice support.
ActiveFeaturesFacebookLogin	Boolean	True		Facebook login.
ActiveFeaturesGoogleLogin	Boolean	True		Google login.
ActiveFeaturesTwitterLogin	Boolean	True		Twitter login.
ActiveFeaturesForumAnalytics	Boolean	True		Forum and search analytics.
ActiveFeaturesBusinessHours	Boolean	False		Business hours.
ActiveFeaturesAgentForwarding	Boolean	True		Agent forwarding.
ActiveFeaturesChat	Boolean	True		Chat.
ActiveFeaturesChatAboutMyTicket	Boolean	True		Chat about my ticket.
ActiveFeaturesCustomerSatisfaction	Boolean	False		Customer satisfaction.
ActiveFeaturesSatisfactionPrediction	Boolean	False		Satisfaction Prediction.
ActiveFeaturesCsatReasonCode	Boolean	True		Csat reason code.
ActiveFeaturesScreencasts	Boolean	True		.
ActiveFeaturesMarkdown	Boolean	True		Markdown in ticket comments.
ActiveFeaturesLanguageDetection	Boolean	True		Language detection.
ActiveFeaturesBccArchiving	Boolean	True		Account has a bcc_archive_address set.
ActiveFeaturesAllowCcs	Boolean	True		Allow ccs.
ActiveFeaturesAdvancedAnalytics	Boolean	True		Advanced analytics.
ActiveFeaturesInsights	Boolean	True		Insights.
ActiveFeaturesSandbox	Boolean	True		Account has a sandbox.
ActiveFeaturesSuspendedTicketNotification	Boolean	True		Suspended ticket notification.
ActiveFeaturesTwitter	Boolean	True		Account monitors at least one Twitter handle.
ActiveFeaturesFacebook	Boolean	True		Account is actively linked to at least one Facebook page.
ActiveFeaturesFeedbackTabs	Boolean	True		Feedback tab has been configured before.
ActiveFeaturesDynamicContents	Boolean	True		Account has at least one dynamic content.
ActiveFeaturesLightAgents	Boolean	True		Account has at least one light agent.
ActiveFeaturesTicketForms	Boolean	True		Ticket forms.
ActiveFeaturesUserOrgFields	Boolean	True		User org fields.
ActiveFeaturesIsAbusive	Boolean	True		Account exceeded trial limits.
ActiveFeaturesRichContentInEmails	Boolean	True		Account supports incoming HTML email.
ApiAcceptedApiAgreement	Boolean	False		Account has accepted the API agreement.
ApiPasswordAccess	Boolean	False		Allow the account to use the API with username/password.
ApiTokenAccess	Boolean	False		Allow the account to use the API with API tokens.
TicketFormsInstructions	String	False		.
RawTicketFormsInstructions	String	True		.
LotusPrefer	Boolean	True		Prefers the current version of Zendesk Support rather than Zendesk Classic.
RulesMacroMostUsed	Boolean	False		Display the most-used macros in the Apply macro list. Defaults to true.
RulesMacroOrder	String	False		Default macro display order. Possible values are alphabetical or position.
LimitsAttachmentSize	Integer	True		The maximum ticket attachment file size (in bytes).
MetricsAccountSize	String	True		An account size category computed from the number of billable agents.

Query and Delete Acticle Attachment in Zendesk.

Table Specific Information

Select

The following queries are processed server side while other filters are processed client side by the Cloud. Allowed for Agents and End users, as long as they can view the associated article.

SELECT * FROM ArticleAttachments WHERE ArticleId = '18214155815057'
SELECT * FROM ArticleAttachments WHERE Id = '18470148791057'
SELECT * FROM ArticleAttachments WHERE Id = '18470148791057' AND Locale='en-us' AND ArticleId = '18214155815057'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Delete

You must specify the Id of the ArticleAttachments to delete it. Allowed for agents.

DELETE FROM ArticleAttachments WHERE Id = '18460736594833'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Assigned ID when the article attachment is created
ArticleId	Long	True	Articles.Id	The associated article, if present
ContentType	String	True		The file type. Example: image/png
ContentUrl	String	True		URL where the attachment file can be downloaded
CreatedAt	Datetime	True		The time the article attachment was created
DisplayFileName	String	True		display_file_name
FileName	String	True		The file name
Inline	Boolean	True		The attached file is shown in the admin interface for inline attachments. Its URL can be referenced in the article's HTML body. Inline attachments are image files directly embedded in the article body. If false, the attachment is listed in the list of attachments. The default value is false
RelativePath	String	True		relative_path
Size	Integer	True		The attachment file size in bytes
UpdatedAt	Datetime	True		The time the article attachment was last updated
Url	String	True		The URL of the article attachment
AttachmentsResponse	String	True		Content of the attachments

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
Locale	String	The locale that the article attachments is being displayed in
IsInline	Boolean	Boolean value that represents Article is inline or not.
Base64EncodedResponse	Boolean	Raw response gets converted into base64encoded The default value is true.

Create, Update, Delete and Query the Article Comments in Zendesk.

Table Specific Information

Select

The following queries are processed server side while other filters are processed client side within the Cloud.

SELECT * FROM ArticleComments WHERE UserId = '19128124956177'
SELECT * FROM ArticleComments WHERE ArticleId = '19206579478289'
SELECT * FROM ArticleComments WHERE ArticleId = '19206579478289' AND Locale = 'en-us'
SELECT * FROM ArticleComments WHERE ArticleId = '19206579478289' AND Id = '19244072685969'
SELECT * FROM ArticleComments WHERE ArticleId = '19206579478289' AND Id = '19244072685969' AND Locale = 'en-us'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Insert

The Locale, ArticleId and Body fields are required to insert. Allowed for End users.

INSERT INTO ArticleComments (ArticleId, Locale, Body, NotifySubscribers) VALUES ('19206579478289', 'en-us', 'Sample Comment Body', false)

Update

You must specify the ArticleId and Id of the comment to update. Allowed for Agents and the end user who created the comment.

UPDATE ArticleComments SET Body = 'Updated Comment' WHERE ArticleId = '19206579478289' AND Id = '19268721555473'

Delete

You must specify the Id of the Comment and ArticleId to delete it. Allowed for Agents and the end user who created the comment.

DELETE FROM ArticleComments WHERE ArticleId = '19206579478289' AND Id = '19269079247633'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned when the comment is created.
AuthorId	Long	False		The id of the author of this comment. Writable on create by Help Center managers.
Body	String	False		The comment made by the author.
Locale	String	False		The locale in which this comment was made.
url	String	True		The API url of this comment.
HtmlUrl	String	True		The url at which the comment is presented in Help Center.
NonAuthorEditorId	Long	True		The user id of whoever performed the most recent (if any) non-author edit. A non-author edit consists of an edit make by a user other than the author that creates or updates the body or author_id. Note that only edits made after May 17, 2021 will be reflected in this field. If no non-author edits have occured since May 17, 2021, then this field will be null.
NonAuthorUpdatedAt	Datetime	True		When the comment was last edited by a non-author user.
SourceId	Long	True		The id of the item on which this comment was made.
SourceType	String	True		The type of the item on which this comment was made. Currently only supports 'Article'.
VoteCount	Integer	True		The total number of upvotes and downvotes.
VoteSum	Integer	True		The sum of upvotes (+1) and downvotes (-1), which may be positive or negative.
CreatedAt	Datetime	False		The time the comment was created. Writable on create by Help Center managers.
UpdatedAt	Datetime	True		The time at which the comment was last updated.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
ArticleId	Long	The Id of the Article.
UserId	Long	The Id of the User.
NotifySubscribers	Boolean	Supplying a notify_subscribers property with a value of false will prevent subscribers to the comment's article from receiving a comment creation email notification. This can be helpful when creating many comments at a time.

Create, delete, and query Article Lables in Zendesk.

Table Specific Information

Select

The following queries are processed server side while other filters are processed client side within the Cloud.

SELECT * FROM ArticleLabels
SELECT * FROM ArticleLabels WHERE Id = '10552059820828'
SELECT * FROM ArticleLabels WHERE ArticleId = '10480909113756'
SELECT * FROM ArticleLabels WHERE ArticleId = '10480909113756' AND Locale = 'en-us'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Insert

The ArticleId and Name columns are required to insert. All fields that are not readonly (readonly="false" in the table) are optional. Allowed for Agents.

INSERT INTO ArticleLabels (ArticleId, Name) VALUES (10480909113756, 'Test')

Delete

You must specify the Id of the ArticleLabel to delete it. Allowed for Agents.

DELETE FROM ArticleLabels WHERE Id = '10552125680668'
DELETE FROM ArticleLabels WHERE Id = '13647939064221' AND ArticleId = '10480909113756'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned when the label is created.
Name	String	False		The actual name of the label.
CreatedAt	Datetime	True		The time at which the label was created.
UpdatedAt	Datetime	True		The time at which the label was last updated.
Url	String	True		The API url of this label.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
ArticleId	Long	The unique ID of the article.
Locale	String	The locale the item is displayed in.

Create, Update, Archive and query Acticles in Zendesk.

Table Specific Information

Select

The following queries are processed server side while other filters are processed client side within the Cloud.

SELECT * FROM Articles
SELECT * FROM Articles WHERE Id = '18467349573905'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Insert

The columns Locale, PermissionGroupId, Title, SectionId and UserSegmentId are required to insert. Allowed for agents.

INSERT INTO Articles(Locale, PermissionGroupId, Title, SectionId, UserSegmentId) VALUES('en-us', 18214159653905, 'The Title', 18214167902481, null)

Update

You must specify the Id of the Article to update it. It only update the article-level metadata such as its Promoted, Position, etc. It does not update translation properties such as the article's Title, Body, Locale, or Draft. Allowed for agents.

UPDATE Articles SET Promoted=true WHERE Id = '18460304837265'

Delete

You must specify the Id of the Article to archive it. You can restore the article using the Help Center user interface. Allowed for agents.

DELETE FROM Articles WHERE Id = 18467236423441

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned when the article is created
AuthorId	Long	True		The id of the user who wrote the article (set to the user who made the request on create by default)
Body	String	False		HTML body of the article. Unsafe tags and attributes may be removed before display. For a list of safe tags and attributes, see Allowing unsafe HTML in Help Center articles in Zendesk help
CommentsDisabled	Boolean	False		True if comments are disabled; false otherwise
CreatedAt	Datetime	True		The time the article was created
Draft	Boolean	False		True if the translation for the current locale is a draft; false otherwise. false by default. Can be set when creating but not when updating. For updating, see Translations
EditedAt	String	True		The time the article was last edited in its displayed locale
HtmlUrl	String	True		The url of the article in Help Center
LabelNames	String	False		An array of label names associated with this article. By default no label names are used. Only available on certain plans
Locale	String	False		The locale that the article is being displayed in
Outdated	Boolean	True		Deprecated. Always false because the source translation is always the most up-to-date translation
OutdatedLocales	String	True		Locales in which the article was marked as outdated
PermissionGroupId	Long	False		The id of the permission group which defines who can edit and publish this article
Position	Integer	False		The position of this article in the article list. 0 by default
Promoted	Boolean	False		True if this article is promoted; false otherwise. false by default
SectionId	Long	False		The id of the section to which this article belongs
SourceLocale	String	True		The source (default) locale of the article
Title	String	False		The title of the article
UpdatedAt	Datetime	True		The time the article was last updated
Url	String	True		The API url of the article
UserSegmentId	Long	False		The id of the user segment which defines who can see this article. Set to null to make it accessible to everyone
VoteCount	Integer	True		The total number of upvotes and downvotes
VoteSum	Integer	True		The sum of upvotes (+1) and downvotes (-1), which may be positive or negative

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
CategoryId	Long	Id of the categories
UserId	Long	Id of author
StartTime	Long	Start Time

Create, Update, Delete and Query the Attributes in Zendesk. An attribute in Zendesk refers to a skill type. Skill types are categories of skills.

Table Specific Information

Select

The following queries are processed server side while other filters are processed client side within the Cloud.

SELECT * FROM Attributes
SELECT * FROM Attributes WHERE Id = 'd5e889c8-6364-11ee-8493-6361d728a3c9'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Insert

The Name field is required to insert. Allowed for agents.

INSERT INTO Attributes (Name) VALUES ('Test')

Update

You must specify the Id of the Attribute to update. Allowed for admins.

UPDATE Attributes SET Name = 'CData' WHERE Id = 'd5e889c8-6364-11ee-8493-6361d728a3c9'

Delete

You must specify the Id of the Attribute to delete it. Allowed for admins.

DELETE FROM Attributes WHERE Id = 'db70666a-6364-11ee-bfc8-7f3b952deb2c'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		Automatically assigned when an attribute is created.
Name	String	False		The name of the attribute.
url	String	True		URL of the attribute.
CreatedAt	Datetime	True		When this record was created.
UpdatedAt	Datetime	True		When this record was last updated.

Create, Update, Delete and Query the Attribute Values in Zendesk. An attribute value in this API refers to a skill. Skills are associated with an agent and determine the agent's suitability to solve a ticket.

Table Specific Information

Select

The following queries are processed server side while other filters are processed client side within the Cloud.

SELECT * FROM AttributeValues WHERE AttributeId = 'd5e889c8-6364-11ee-8493-6361d728a3c9'
SELECT * FROM AttributeValues WHERE AttributeId = 'd5e889c8-6364-11ee-8493-6361d728a3c9' AND Id = '5943809a-6f5d-4f6e-8669-e8a65bd3583b'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Insert

The AttributeId and Name fields are required to insert. Allowed for admins.

INSERT INTO AttributeValues (AttributeId, Name) VALUES ('d5e889c8-6364-11ee-8493-6361d728a3c9', 'TestValue')

Update

You must specify the AttributeId and Id of the AttributeValue to update. Allowed for admins.

UPDATE AttributeValues SET Name = 'CData' WHERE AttributeId = 'd5e889c8-6364-11ee-8493-6361d728a3c9' AND Id = '5943809a-6f5d-4f6e-8669-e8a65bd3583b'

Delete

You must specify the AttributeId and Id of the AttributeValue to delete it. Allowed for agents.

DELETE FROM AttributeValues WHERE AttributeId = 'db70666a-6364-11ee-bfc8-7f3b952deb2c' AND Id = '5943809a-6f5d-4f6e-8669-e8a65bd3583b'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		Automatically assigned when an attribute value is created.
AttributeId	String	False	Attributes.Id	The Attribute Id.
Name	String	False		The name of the attribute value.
url	String	True		URL of the attribute.
CreatedAt	Datetime	True		When this record was created.
UpdatedAt	Datetime	True		When this record was last updated.

Create, update, delete, and query Automations in Zendesk.

Table Specific Information

Select

The following queries are processed server side, while other filters are processed client side within the Cloud.

SELECT * FROM Automations WHERE Id = '123'

SELECT * FROM Automations ORDER BY Position 

SELECT * FROM Automations ORDER BY CreatedAt  

SELECT * FROM Automations ORDER BY UpdatedAt

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Insert

The Title, ConditionsAll, and Actions fields are required to insert. Allowed for agents.

INSERT INTO Automations (Title, ConditionsAll, Actions) VALUES ('Roger Wilco II', '[{ \"field\": \"status\", \"operator\": \"is\",\"value\": \"open\" }, {\"field\": \"priority\", \"operator\": \"less_than\", \"value\": \"high\" }]', '[{\"field\": \"status\", \"value": \"solved\"}]')

Update

You must specify the Id of the automation to update. Title is required. Active and Position are optional. Updating an action updates the containing array, clearing the other actions. Include all your actions when updating any action. Allowed for agents.

UPDATE Automations SET Title = 'Roger Wilco III' WHERE Id = '123'

Delete

You must specify the Id of the automation to delete it. Allowed for agents.

DELETE FROM Automations WHERE Id = '123'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned when created.
Title	String	False		The title of the automation.
Active	Boolean	False		Whether the automation is active.
Position	Integer	False		The position of the automation.
ConditionsAll	String	False		An object that describes the conditions under which the automation will execute.
ConditionsAny	String	False		An object that describes the conditions under which the automation will execute.
Actions	String	False		An object describing what the automation will do.
CreatedAt	Datetime	True		The time the automation was created.
UpdatedAt	Datetime	True		The time of the last update of the automation.

Create, Delete and Query the Bookmarks in Zendesk.

Table Specific Information

Select

The following queries are processed server side while other filters are processed client side within the Cloud.

SELECT * FROM Bookmarks

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Insert

The TicketId field is required to insert. Allowed for agents.

INSERT INTO Bookmarks (TicketId) VALUES ('4')

Delete

You must specify the Id of the Bookmark to delete it. Allowed for agents.

DELETE FROM Bookmarks WHERE Id = '19152874442641'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned when the bookmark is created.
Ticket	String	True		The ticket object.
url	String	True		The API url of this bookmark.
CreatedAt	Datetime	True		The time the bookmark was created.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
TicketId	Integer	The time the bookmark was created.

Create, delete, update, and query Brands in Zendesk.

Table Specific Information

Select

The following queries are processed server side while other filters are processed client side within the Cloud.

SELECT * FROM Brands WHERE Id = '123'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Insert

The Name and Subdomain fields are required to insert. Allowed for admins.

INSERT INTO Brands (Name, Subdomain) VALUES ('Brand 1', 'brand1')

Update

You must specify the Id of the automation to update. Allowed for agents.

UPDATE Brands SET Name = 'Brand 2', Subdomain = 'brand2', HostMapping = 'brand2.com', Active = true  WHERE Id = '123'

Delete

You must specify the Id of the automation to delete it. Allowed for agents.

DELETE FROM Brands WHERE Id = '123'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Long	False		Automatically assigned when the brand is created.
Name	String	False		The name of the brand.
CreatedAt	Datetime	False		The time the brand was created.
UpdatedAt	Datetime	False		The time of the last update of the brand.
BrandUrl	String	False		The url of the brand.
HasHelpCenter	Boolean	False		If the brand has a Help Center.
HelpCenterState	String	False		The state of the Help Center: enabled, disabled, or restricted.
Active	Boolean	False		If the brand is set as active.
Default	Boolean	False		Is the brand the default brand for this account.
LogoId	Long	False		The id of logo image for this brand.
LogoUrl	String	False		The url of logo image for this brand.
LogoFileName	String	False		The name of logo image for this brand.
LogoContentUrl	String	False		The content url of logo image for this brand.
LogoMappedContentUrl	String	False		The mapped content url of logo image for this brand.
LogoContentType	String	False		The content type of logo image for this brand.
LogoSize	Integer	False		The size of logo image for this brand.
TicketFormIds	String	False		The ids of ticket forms that are available for use by a brand.
HostMapping	String	False		The hostmapping to this brand, if any (only admins view this key).
Subdomain	String	False		The subdomain of the brand.
SignatureTemplate	String	False		The signature template for a brand.
Url	String	False		The API url of this brand.

Create, update, delete, and query Categories in Zendesk.

Table Specific Information

Select

The following queries are processed server side while other filters are processed client side within the Cloud.

SELECT * FROM Categories
SELECT * FROM Categories WHERE Id = '13625378761117'
SELECT * FROM Categories WHERE Locale = 'en-us'
SELECT * FROM Categories WHERE Locale = 'en-us' AND Id = '13625378761117'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Insert

The Name field is required to insert. Allowed for Help Center managers.

INSERT INTO Categories (Name, Locale) VALUES ('Test CData', 'en-us')

Update

You must specify the Id of the Category to update. It only update the category-level metadata such as Position, etc. It does not update category translation properties such as Name, Description, etc. All fields that are not readonly (readonly="false" in the table) are optional. Allowed for Help Center managers.

UPDATE Categories SET Position = 2 WHERE Id = '13626563785373'

Delete

You must specify the Id of the Category to delete it. Allowed for Help Center managers.

DELETE FROM Categories WHERE Id = '13626686793885'
DELETE FROM Categories WHERE Id = '13626686793885' AND Locale = 'en-us'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned when creating categories.
Name	String	False		The name of the category.
Description	String	False		The description of the category.
Locale	String	False		The locale where the category is displayed.
CreatedAt	Datetime	True		The time at which the category was created.
UpdatedAt	Datetime	True		The time at which the category was last updated.
Url	String	True		The API url of this category.
HtmlUrl	String	True		The url of this category in Help Center.
Outdated	Boolean	True		Whether the category is out of date.
Position	Integer	False		The position of this category relative to other categories.
SourceLocale	String	True		The source (default) locale of the category.

Create, Update, Delete and Query the Content Subscriptions in Zendesk. Users can subscribe to sections, articles, community posts, and community topics.

Table Specific Information

Select

The following queries are processed server side while other filters are processed client side within the Cloud.

Below queries lists the content subscriptions of a given user. To list your own subscriptions, specify me as the user id.

SELECT * FROM ContentSubscriptions WHERE UserId = '19128124956177'
SELECT * FROM ContentSubscriptions WHERE UserId = 'me'

Below queries lists the subscriptions to a given topic.

SELECT * FROM ContentSubscriptions WHERE TopicId = '19209878690449'
SELECT * FROM ContentSubscriptions WHERE TopicId = '19209878690449' AND Id = '19209922023185'

Below queries lists the subscriptions to a given post.

SELECT * FROM ContentSubscriptions WHERE PostId = '19206579516945'
SELECT * FROM ContentSubscriptions WHERE PostId = '19206579516945' AND Id = '19210209123217'

Below queries lists the subscriptions to a given section. Here along with the SectionId, you need to provide the Locale value.

SELECT * FROM ContentSubscriptions WHERE SectionId = '19206579484689' AND Locale = 'en-us'
SELECT * FROM ContentSubscriptions WHERE SectionId = '19206579484689' AND Locale = 'en-us' AND Id = '19210938828817'

Below queries lists the subscriptions to a given article. Here along with the ArticleId, you need to provide the Locale value.

SELECT * FROM ContentSubscriptions WHERE ArticleId = '19206609899793' AND Locale = 'en-us'
SELECT * FROM ContentSubscriptions WHERE ArticleId = '19206609899793' AND Locale = 'en-us' AND Id = '19211885836945'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Insert

To create a Subscription for a given Topic, TopicId column is required. Allowed for End-users. Agents with the Help Center manager role can optionally supply a UserId value. If provided, the user associated with UserId will be subscribed to the topic.

INSERT INTO ContentSubscriptions (TopicId, IncludeComments) VALUES ('19209878690449', true)

To create a Subscription for a given Post, PostId column is required. Allowed for End-users. Agents with the Help Center manager role can optionally supply a UserId value. If provided, the user associated with UserId will be subscribed to the post.

INSERT INTO ContentSubscriptions (PostId, UserId) VALUES ('19206579516945', '19157178632977')

To create a Subscription for a given Section, SectionId, Locale and SourceLocale columns are required. Allowed for End-users. Agents with the Help Center manager role can optionally supply a UserId value. If provided, the user associated with UserId will be subscribed to the section.

INSERT INTO ContentSubscriptions (SectionId, Locale, SourceLocale) VALUES ('19206579484689', 'en-us', 'en-us')

To create a Subscription for a given Article, ArticleId, Locale and SourceLocale columns are required. Allowed for End-users. Agents with the Help Center manager role can optionally supply a UserId value. If provided, the user associated with UserId will be subscribed to the article.

INSERT INTO ContentSubscriptions (ArticleId, Locale, SourceLocale) VALUES ('19206609899793', 'en-us', 'en-us')

Update

Update can be perform only on Topic Subscription. The TopicId and Id of the Subscription are required to Update it. Allowed for End-users.

UPDATE ContentSubscriptions SET IncludeComments = false WHERE TopicId = '19209878690449' AND Id = '19209922023185'

Delete

To remove a subscription to a given topic, Id and TopicId columns are required. Allowed for End-users.

DELETE FROM ContentSubscriptions WHERE TopicId = '19209878690449' AND Id = '19209922023185'

To remove a subscription to a given post, Id and PostId columns are required. Allowed for End-users.

DELETE FROM ContentSubscriptions WHERE PostId = '19206579516945' AND Id = '19210420873745'

To remove the specified subscription from the specified section, Id, SectionId and Locale columns are required. Allowed for End-users.

DELETE FROM ContentSubscriptions WHERE SectionId = '19206579516945' AND Id = '19210420873745' AND Locale = 'en-us'

To remove the specified subscription from the specified article, Id, ArticleId and Locale columns are required. Allowed for End-users.

DELETE FROM ContentSubscriptions WHERE ArticleId = '19206609899793' AND Id = '19211885836945' AND Locale = 'en-us'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned when the subscription is created.
UserId	String	False	Users.Id	The id of the user who has this subscription.
ContentId	Long	True		The id of the subscribed item.
ContentType	String	True		The type of the subscribed item.
IncludeComments	Boolean	False		Subscribe also to article comments/post comments. Only for section/topic subscriptions.
Locale	String	False		The locale of the subscribed item.
SourceLocale	String	False		Used only for Create Section Subscription and Create Article Subscription, where it's mandatory. Selects the locale of the content to be subscribed.
Url	String	True		The API url of the subscription.
CreatedAt	Datetime	True		The time at which the subscription was created.
UpdatedAt	Datetime	True		The time at which the subscription was last updated.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
TopicId	Long	Id of the Topic.
PostId	Long	Id of the Post.
SectionId	Long	Id of the Section.
ArticleId	Long	Id of the Article.

Create, Update, Delete and Query the Content Tags in Zendesk.

Table Specific Information

Select

The following queries are processed server side while other filters are processed client side within the Cloud.

SELECT * FROM ContentTags
SELECT * FROM ContentTags WHERE Id = '01HCCV8145J2MBX6XZ103G10CH'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Insert

The Name field is required to insert. Allowed for Guide managers and Guide agents.

INSERT INTO ContentTags (Name) VALUES ('Test')

Update

You must specify the Id of the ContentTag to update. Allowed for Guide managers.

UPDATE ContentTags SET Name = 'CData' WHERE Id = '01HCEJVFV4X9MA9D2SBC86FE5S'

Delete

You must specify the Id of the ContentTag to delete it. Allowed for Guide managers.

DELETE FROM ContentTags WHERE Id = '01HCEJVFV4X9MA9D2SBC86FE5S'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		Automatically assigned when the content tag is created.
Name	String	False		The name of the content tag.
CreatedAt	Datetime	True		When the content tag was created.
UpdatedAt	Datetime	True		When the content tag was last updated.

Create, Update, Delete and Query CustomAgentRoles in Zendesk.

Table Specific Information

Select

The following queries are processed server side while other filters are processed client side within the Cloud.

Allowed for Agents.

SELECT * FROM CustomAgentRoles

When Id is mention in the criteria, then it wil be allowed only for Administrators and Agents with the manage_roles permission.

SELECT * FROM CustomAgentRoles WHERE Id = '13575064971293'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Insert

The Name field is required to insert. Allowed for Administrators and Agents with the manage_roles permission.

INSERT INTO CustomAgentRoles(Name, Description, ConfigurationChatAccess, ConfigurationUserViewAccess) VALUES('Test', 'Description', true, 'readonly')

Update

You must specify the Id of the CustomAgentRole to update it. All fields that are not readonly (readonly="false" in the table) are optional. Allowed for Administrators and Agents with the manage_roles permission.

UPDATE CustomAgentRoles SET Name = 'Updated Name', Description = 'Updated description', ConfigurationChatAccess = false, ConfigurationUserViewAccess='readonly' WHERE Id='13575064971293'

Delete

You must specify the Id of the CustomAgentRole to delete it. Allowed for Administrators and Agents with the manage_roles permission.

DELETE FROM CustomAgentRoles WHERE Id = '13575064971293'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned upon creation.
Name	String	False		Name of the custom role.
Description	String	False		A description of the role.
CreatedAt	Datetime	True		The time the record was created.
UpdatedAt	Datetime	True		The time the record was last updated.
ConfigurationChatAccess	Boolean	False		Boolean value that checks whether or not the agent has access to Chat.
ConfigurationEndUserProfileAccess	String	False		What the agent can do with end-user profiles. Allowed values are edit, edit-within-org, full, readonly.
ConfigurationForumAccess	String	False		The kind of access the agent has to Guide. Allowed values are edit-topics, full, readonly.
ConfigurationForumAccessRestrictedContent	Boolean	False		Configuration Forum Access Restricted Content.
ConfigurationMacroAccess	String	False		What the agent can do with macros. Allowed values are full, manage-group, manage-personal, readonly.
ConfigurationManageBusinessRules	Boolean	False		Whether or not the agent can create and manage schedules and view rules analysis.
ConfigurationManageDynamicContent	Boolean	False		Whether or not the agent can access dynamic content.
ConfigurationManageExtensionsAndChannels	Boolean	False		Whether or not the agent can manage channels and extensions.
ConfigurationManageFacebook	Boolean	False		Whether or not the agent can manage facebook pages.
ConfigurationOrganizationEditing	Boolean	False		Whether or not the agent can add or modify organizations.
ConfigurationReportAccess	String	False		What the agent can do with reports. Allowed values are full, none, readonly.
ConfigurationTicketAccess	String	False		What kind of tickets the agent can access. Allowed values are all, assigned-only, within-groups, within-groups-and-public-groups, within-organization.
ConfigurationTicketCommentAccess	String	False		What kind of tickets the agent can access. Allowed values are all, assigned-only, within-groups, within-groups-and-public-groups, within-organization.
ConfigurationTicketDeletion	Boolean	False		Whether or not the agent can delete tickets.
ConfigurationTicketMerge	Boolean	False		Whether or not the agent can merge tickets.
ConfigurationTicketTagEditing	Boolean	False		Whether or not the agent can edit ticket tags.
ConfigurationTwitterSearchAccess	Boolean	False		Configuration Twitter Search Access.
ConfigurationViewAccess	String	False		What the agent can do with views. Allowed values are full, manage-group, manage-personal, playonly, readonly.
ConfigurationUserViewAccess	String	False		What the agent can do with customer lists. Allowed values are full, manage-group, manage-personal, none, readonly.
ConfigurationAssignTicketsToAnyGroup	Boolean	False		Whether or not the agent can assign tickets to any group.
ConfigurationCustomObjects	String	False		A list of custom object keys mapped to JSON objects that define the agent's permissions (scopes) for each object. Allowed values: are read, update, delete, create. The read permission is required if any other scopes are specified.
ConfigurationEndUserListAccess	String	False		Whether or not the agent can view lists of user profiles. Allowed values are full, none.
ConfigurationExploreAccess	String	False		Allowed values are edit, full, none, readonly.
ConfigurationGroupAccess	Boolean	False		Whether or not the agent can add or modify groups.
ConfigurationLightAgent	Boolean	False		Configuration Light Agent.
ConfigurationManageAutomations	Boolean	False		Whether or not the agent can create and manage automations.
ConfigurationManageContextualWorkspaces	Boolean	False		Whether or not the agent can view, add, and edit contextual workspaces.
ConfigurationManageGroupMemberships	Boolean	False		Whether or not the agent can create and manage group memberships.
ConfigurationManageGroups	Boolean	False		Whether or not the agent can create and modify groups.
ConfigurationManageOrganizationFields	Boolean	False		Whether or not the agent can create and manage organization fields.
ConfigurationManageOrganizations	Boolean	False		Whether or not the agent can create and modify organizations.
ConfigurationManageRoles	String	False		Whether or not the agent can create and manage custom roles with the exception of the role they're currently assigned. Doesn't allow agents to update role assignments for other agents. Allowed values are all-except-self, none.
ConfigurationManageSkills	Boolean	False		Whether or not the agent can create and manage skills.
ConfigurationManageSlas	Boolean	False		Whether or not the agent can create and manage SLAs.
ConfigurationManageSuspendedTickets	Boolean	False		Whether or not the agent can manage suspended tickets.
ConfigurationManageTeamMembers	String	False		Whether or not the agent can manage team members. Allows agents to update role assignments for other agents. Allowed values are all-with-self-restriction, readonly, none.
ConfigurationManageTicketFields	Boolean	False		Whether or not the agent can create and manage ticket fields.
ConfigurationManageTicketForms	Boolean	False		Whether or not the agent can create and manage ticket forms.
ConfigurationManageTriggers	Boolean	False		Whether or not the agent can create and manage triggers.
ConfigurationManageUserFields	Boolean	False		Whether or not the agent can create and manage user fields.
ConfigurationModerateForums	Boolean	False		Configuration Moderate Forums.
ConfigurationOrganizationNotesEditing	Boolean	False		Whether or not the agent can add or modify organization notes.
ConfigurationSideConversationCreate	Boolean	False		Whether or not the agent can contribute to side conversations.
ConfigurationTicketEditing	Boolean	False		Whether or not the agent can edit ticket properties.
ConfigurationTicketRedaction	Boolean	False		Whether or not the agent can redact content from tickets. Only applicable to tickets permitted by ticket_access.
ConfigurationViewDeletedTickets	Boolean	False		Whether or not the agent can view deleted tickets.
ConfigurationVoiceAccess	Boolean	False		Whether or not the agent can answer and place calls to end users.
ConfigurationVoiceDashboardAccess	Boolean	False		Whether or not the agent can view details about calls on the Talk dashboard.
RoleType	Integer	True		The user's role id. It is 0 for a custom agent.
TeamMemberCount	Integer	True		The number of team members assigned to this role.

Create, delete, update, and query Custom Objects in Zendesk.

Select

The CustomObjects table supports the ObjectName column in the WHERE clause. This table supports the following operator: '='. For example:

SELECT * FROM CustomObjects WHERE ObjectName = 'house'

Insert

You can insert any field into the CustomObjects table that is not read-only. To insert Properties details for a custom object, use the #TEMP table to insert the fields of the property. The fields of the Property are present in the CustomObjectField view. For Example:

INSERT INTO CustomObjectField#TEMP (FieldName, Type, Description, Required) VALUES ('NumOfRooms', 'integer', 'The number of rooms.', true)
INSERT INTO CustomObjectField#TEMP (FieldName, Type, Description, Required) VALUES ('NumOfBaths', 'integer', 'The number of baths.', true)
INSERT INTO CustomObjectField#TEMP (FieldName, Type, Description, Required) VALUES ('Balcony', 'boolean', 'Whether or not balcony is there.', true)
INSERT INTO CustomObjectField#TEMP (FieldName, Type, Description) VALUES ('PropertyAge', 'string', 'Old or new construction.')
INSERT INTO CustomObjects (ObjectName, Properties) VALUES ('house', CustomObjectField#TEMP)

Update

You can update only Properties column in the CustomObjects Table. To update the properties details for a custom object, Use the #TEMP table to insert the fields of the property. The fields of the Property is present in CustomObjectField view.

INSERT INTO CustomObjectField#TEMP (FieldName, Type, Description, Required) VALUES ('CarParking', 'string', 'Whether or not car parking is available', true)");
INSERT INTO CustomObjectField#TEMP (FieldName, Required) VALUES ('balcony', false)");
UPDATE CustomObjects SET Properties = 'CustomObjectField#TEMP' WHERE ObjectName = 'house'");

Delete

To delete a Custom Object, the ObjectName is required.

DELETE FROM CustomObjects WHERE ObjectName = 'house'

Columns

Name	Type	ReadOnly	References	Description
ObjectName [KEY]	String	False		A user-defined unique identifier. Writable on create only.
CreatedAt	Datetime	True		The time the object type was created.
UpdatedAt	Datetime	True		The time of the last update of the object type.
Version	String	False		The version of this schema.
Properties	String	False		A description of the object record, up to a maximum of 32 KB.

Create, update, and query custom ticket statuses in zendesk.

Table Specific Information

Select

The following queries are processed server-side, while other filters are processed client-side in the Cloud.

SELECT * FROM CustomTicketStatuses
SELECT * FROM CustomTicketStatuses WHERE Id = 9930628462492

Insert

INSERT INTO CustomTicketStatuses(active,agentlabel,description,enduserdescription,enduserlabel,statuscategory) VALUES('true', 'Try to Respond quickly', 'Customer needs a response quickly', 'Your ticket is being responded to', 'Urgent processing', 'open')

Update

UPDATE CustomTicketStatuses SET description = 'Customer needs a response quickly.' WHERE Id = 9930628462492

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned when the custom ticket status is created.
Active	Boolean	False		If true, the custom status is set to active, If false, the custom status is set to inactive.
URL	String	True		The label displayed to agents. Maximum length is 48 characters.
AgentLabel	String	False		The label displayed to agents. Maximum length is 48 characters.
Default	Boolean	False		If true, the custom status is set to default. If false, the custom status is set to non-default.
Description	String	False		The description of when the user should select this custom ticket status.
StatusCategory	String	False		The status category the custom ticket status belongs to. The allowed values are new, open, hold, pending, solved.
EndUserLabel	String	False		The label displayed to end users. Maximum length is 48 characters.
EndUserDescription	String	False		The description displayed to end users.
RawAgentLabel	String	True		The dynamic content placeholder. If the dynamic content placeholder is not available, this is the agent_label value.
RawDescription	String	True		The dynamic content placeholder. If the dynamic content placeholder is not available, this is the raw_description value.
RawEndUserLabel	String	True		The dynamic content placeholder. If the dynamic content placeholder is not available, this is the raw_end_user_label value.
RawEndUserDescription	String	True		The dynamic content placeholder. If the dynamic content placeholder is not available, this is the raw_end_user_description value.
CreatedAt	Datetime	True		The date and time the custom ticket status was created.
UpdatedAt	Datetime	True		The time of the last update of the ticket field.

Create, delete, and query Group Memberships in Zendesk.

Table Specific Information

Select

The following queries are processed server side while other filters are processed client side within the Cloud.

SELECT * FROM GroupMemberships WHERE Id = '123'

SELECT * FROM GroupMemberships WHERE UserId = '123'

SELECT * FROM GroupMemberships WHERE GroupId = '123'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Insert

The UserId and GroupId fields are required to insert (assigns an agent to a given group). Allowed for admins.

INSERT INTO GroupMemberships (UserId, GroupId) VALUES ('72', '88')

Delete

You must specify the Id of the membership to delete it (immediately removes a user from a group and schedules a job to unassign all working tickets that are assigned to the given user and group combination). Allowed for admins.

DELETE FROM GroupMemberships WHERE Id = '123'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned when the ticket is created.
UserId	Long	False	Users.Id	The id of an agent.
GroupId	Long	False	Groups.Id	The id of a group.
Default	Boolean	False		If true, tickets assigned directly to the agent will assume this membership's group.
CreatedAt	Datetime	True		The time the membership was created.
UpdatedAt	Datetime	True		The time of the last update of the membership.
Url	String	True		The API url of this record.

Create, update, delete, and query Groups in Zendesk.

Table Specific Information

Select

The following queries are processed server side while other filters are processed client side within the Cloud.

SELECT * FROM Groups WHERE Id = '123'

SELECT * FROM Groups WHERE UserId = '123'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Insert

The Name field is required to insert. Allowed for admins.

INSERT INTO Groups (Name) VALUES ('My Group')

Update

You must specify the Id of the group to update it. All fields that are not readonly (readonly="false" in the table) are optional. Allowed for admins.

UPDATE Groups SET Name = 'Interesting Group' WHERE Id = '123'

Delete

You must specify the Id of the group to delete it. Note that you cannot delete the default group of the account. Allowed for admins.

DELETE FROM Groups WHERE Id = '123'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned when the ticket is created.
Name	String	False		The name of the group.
CreatedAt	Datetime	True		The time the group was created.
UpdatedAt	Datetime	True		The time of the last update of the group.
Deleted	Boolean	True		Deleted groups get marked as such.
Url	String	True		The API url of this group.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
UserId	Long	The user id used to query groups

Create, update, delete, and query Schedules in Zendesk.

Table Specific Information

Select

The following queries are processed server side while other filters are processed client side within the Cloud.

SELECT * FROM Holidays WHERE ScheduleId = '123'

SELECT * FROM Holidays WHERE ScheduleId = '123' AND Id = '456'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Insert

The ScheduleId, Name, StartDate and EndDate fields are required to insert. Allowed for admins.

INSERT INTO Holidays (ScheduleId, Name, StartDate, EndDate) VALUES ('360000022454', 'Christmas', '2016-12-25', '2016-12-25')

Update

You must specify the ScheduleId and Id of the holiday to update.Allowed for admins.

UPDATE Holidays SET Name = 'Christmas', StartDate = '2018-12-25', EndDate = '2018-12-25'  WHERE ScheduleId = '123' AND Id = '456'

Delete

You must specify the ScheduleId and Id of the holiday to delete it. Allowed for admins.

DELETE FROM Holidays WHERE ScheduleId = '123' AND Id = '456'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned upon creation.
ScheduleId	Long	False	Schedules.Id	Id of the schedule the holiday belongs to.
Name	String	False		Name of the holiday.
StartDate	Date	False		Time when the holiday starts.
EndDate	Date	False		Time when the holiday ends.

View and create links between your Jira and Zendesk instances.

Table Specific Information

Select

The following queries are processed server side while other filters are processed client side within the Cloud.

SELECT * FROM JiraLinks WHERE Id = 123
SELECT * FROM JiraLinks WHERE TicketId = 123
SELECT * FROM JiraLinks WHERE IssueId = 123

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Insert

The Name and Subdomain fields are required to insert. Allowed for admins.

INSERT INTO JiraLinks (TicketId, IssueId, IssueKey) VALUES (1, 1, 'TP-1')

Delete

You must specify the Id of the automation to delete it. Allowed for agents.

DELETE FROM JiraLinks WHERE Id = 123

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Integer	True		Automatically assigned when the link is created.
TicketId	Integer	False	Tickets.Id	The id of the Zendesk ticket.
IssueId	Integer	False		The id of the Jira issue.
IssueKey	String	False		The key for the Jira issue.
CreatedAt	Datetime	True		The time at which the link was created.
UpdatedAt	Datetime	True		The time at which the link was last updated.

Create, update, delete, and query Macros in Zendesk.

Table Specific Information

Select

The following queries are processed server side while other filters are processed client side within the Cloud.

SELECT * FROM Macros WHERE Id = '123'

SELECT * FROM Macros WHERE Active = true

SELECT * FROM Macros ORDER BY CreatedAt

SELECT * FROM Macros ORDER BY UpdateddAt

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Insert

The Title and Actions fields are required to insert. Allowed for agents.

INSERT INTO Macros (Title, Actions) VALUES ('Roger Wilco II', '[{\"field\": \"status\", \"value": \"solved\"}]')

Update

You must specify the Id of the macro to update. Updating an action updates the containing array, clearing the other actions. Include all your actions when updating any action.Allowed for agents.

UPDATE Macros SET Title = 'Roger Wilco III' WHERE Id = '123'

Delete

You must specify the Id of the macro to delete it. Allowed for agents.

DELETE FROM Macros WHERE Id = '123'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Long	False		Automatically assigned when created.
Title	String	False		The title of the macro.
Actions	String	False		An object describing what the macro will do.
Active	Boolean	False		Useful for determining if the macro should be displayed.Only active macros if true, inactive macros if false.
Description	String	False		The description of the macro.
Position	Integer	False		The position of the macro.
Restrictions	String	False		Who may access this macro. Will be null when everyone in the account can access it.
CreatedAt	Datetime	False		The time the macro was created.
UpdatedAt	Datetime	False		The time of the last update of the macro.
Access	String	False		Only macros with given access. Possible values are personal, shared, or account.
Category	String	False		Only macros within given category.
GroupId	Long	False	Groups.Id	Only macros belonging to given group.
OnlyViewable	Boolean	False		Only macros that can be applied to tickets if true, All macros the current user can manage if false. Defaults to false.
Attachments	String	False		An array of macro attachment IDs to be associated with the macro, used in Insertion

Create, Update, Delete and Query the Management Permission Groups in Zendesk. A management permission group defines which agents can create, update, archive, and publish articles. It consists of a set of privileges, each of which is mapped to a user segment. Agents receive whichever privileges are associated with the user segments they belong to.

Table Specific Information

Select

The following queries are processed server side while other filters are processed client side within the Cloud.

SELECT * FROM ManagementPermissionGroups
SELECT * FROM ManagementPermissionGroups WHERE Id = '19162149101585'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Insert

The Name column is required to insert. All fields that are not readonly (readonly="false" in the table) are optional for insert. Allowed for Help Center managers.

INSERT INTO ManagementPermissionGroups (Name, Edit) VALUES ('Test', '19162093613969, 19236810082193')

Update

You must specify the Id of the ManagementPermissionGroup to update. All fields that are not readonly (readonly="false" in the table) are optional for insert. Allowed for Help Center managers.

UPDATE ManagementPermissionGroups SET Name = 'UpdatedName' WHERE Id = '19239392699537'

Delete

You must specify the Id of the ManagementPermissionGroup to delete it. Allowed for Help Center managers.

DELETE FROM ManagementPermissionGroups WHERE Id = '19239392699537'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned when the permission group is created.
BuiltIn	Boolean	True		Whether the permission group is built-in. Built-in permission groups cannot be modified.
Name	String	False		Permission group name.
Edit	String	False		The ids of user segments that have edit privileges. For insertion and updation provide these values separated by comma.
Publish	String	False		The ids of user segments that have publish privileges. For insertion and updation provide these values separated by comma.
CreatedAt	Datetime	True		When the permission group was created.
UpdatedAt	Datetime	True		When the permission group was last updated.

Create, update, delete, and query Organization Fields in Zendesk.

Table Specific Information

Select

The following queries are processed server side while other filters are processed client side within the Cloud.

SELECT * FROM OrganizationFields WHERE Id = '123'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Insert

The Type, Title, and Key fields are required to insert. The types of custom fields that can be created are the following: text (default when no Type is specified), textarea, checkbox, date, integer, decimal, and regex (when Type is regex, RegexpForValidation is required too). Allowed for admins.

INSERT INTO OrganizationFields (Type, Title, Key) VALUES ('text', 'Support description', 'support_description')

You can also create a Lookup Relationships. A lookup relationship field is a custom field whose type is "lookup". This type of custom field gives you the ability to create a relationship from a source object to a target object. To create a lookup relationship fields, Type, Key and RelationshipTargetType columns are required. The Type column value must be "lookup". A suitable combination of Field, Operator and Value is required for insertion in RelationshipFilterAll and RelationshipFilterAny. Here is a list of the possible combinations: "https://developer.zendesk.com/documentation/ticketing/reference-guides/conditions-reference/#shared-conditions".

INSERT INTO OrganizationFieldsRelationshipFilterAll#temp(Field, Operator, Value) VALUES('status', 'less_than', 'solved')
INSERT INTO OrganizationFieldsRelationshipFilterAny#temp(Field, Operator, Value) VALUES('status', 'less_than', 'solved')
INSERT INTO OrganizationFields (Type, Title, Key, RelationshipTargetType, RelationshipFilterAll, RelationshipFilterAny) VALUES ('lookup', 'Support description', 'support_description5', 'zen:ticket', 'OrganizationFieldsRelationshipFilterAll#temp', 'OrganizationFieldsRelationshipFilterAny#temp')

Update

You must specify the Id of the organization field to update. All fields that are not readonly (readonly="false" in the table) are optional. Allowed for admins.

UPDATE OrganizationFields SET Title = 'Updated title' WHERE Id = '123'

Delete

You must specify the Id of the organizational field to delete it. Allowed for admins.

DELETE FROM OrganizationFields WHERE Id = '123'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Long	False		Automatically assigned upon creation.
Key	String	False		A unique key that identifies this custom field. Required on create.This is used for updating the field and referencing in placeholders. After a field is created, you cannot change its key.
Type	String	False		Type of the custom field: checkbox, date, decimal, dropdown, integer, regexp, text, or textarea. After a field is created, you cannot change its type.
Title	String	False		The title of the custom field.
RawTitle	String	False		The dynamic content placeholder, if present, or the title value, if not.
Description	String	False		User-defined description of this field s purpose.
RawDescription	String	False		The dynamic content placeholder, if present, or the description value, if not.
Position	Integer	False		Ordering of the field relative to other fields.
Active	Boolean	False		If true, this field is available for use.
System	Boolean	False		If true, only active and position values of this field can be changed.
RegexpForValidation	String	False		Regular expression field only. The validation pattern for a field value to be deemed valid..
CreatedAt	Datetime	False		The time the ticket field was created.
UpdatedAt	Datetime	False		The time of the last update of the ticket field.
Tag	String	False		Optional for custom field of type checkbox; not presented otherwise.
CustomFieldOptions	String	False		Required and presented for a custom field of type dropdown.
Url	String	False		The URL for this resource.
RelationshipFilterAll	String	False		A filter definition that allows your autocomplete to filter down results with Logical AND.
RelationshipFilterAny	String	False		A filter definition that allows your autocomplete to filter down results with Logical OR.
RelationshipTargetType	String	False		A representation of what type of object the field references. Options are zen:user, zen:organization, zen:ticket, or zen:custom_object:CUSTOM_OBJECT_KEY. For example zen:custom_object:apartment.

Create, delete, and query Organization Memberships in Zendesk.

Table Specific Information

Select

The following queries are processed server side while other filters are processed client side within the Cloud.

SELECT * FROM OrganizationMemberships WHERE Id = '123'

SELECT * FROM OrganizationMemberships WHERE UserId = '123'

SELECT * FROM OrganizationMemberships WHERE OrganizationId = '123'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Insert

The The UserId and OrganizationId fields are required to insert (assigns a user to a given organization). Allowed for agents.

INSERT INTO OrganizationMemberships (UserId, OrganizationId) VALUES ('772', '881')

Delete

You must specify the Id of the membership to delete it. Allowed for admins.

DELETE FROM OrganizationMemberships WHERE Id = '123'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned when the membership is created.
OrganizationId	Long	False	Organizations.Id	The ID of the organization associated with this user, in this membership.
UserId	Long	False	Users.Id	The ID of the user for whom this memberships belongs.
Default	Boolean	False		Denotes whether this is the default organization membership for the user. If false, returns null.
CreatedAt	Datetime	True		When this record was created.
UpdatedAt	Datetime	True		When this record last got updated.
Url	String	True		The url of this resource.

Create, delete, update, and query Organizations in Zendesk.

Table Specific Information

Select

The following queries are processed server side while other filters are processed client side within the Cloud.

SELECT * FROM Organizations WHERE Id = '123'

SELECT * FROM Organizations WHERE Id IN ('123', '456')

SELECT * FROM Organizations WHERE UserId = '123'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Insert

The Name field is required to insert. Allowed for admins. Note: You must provide a unique name for each organization. Normally the system does not allow records to be created with identical names. However, a race condition can occur if you make two or more identical POSTs very close to each other, causing the records to have identical organization names.

INSERT INTO Organizations (Name) VALUES ('My Organization')

To create many organizations see the Batch Processing section for an example.

Update

You must specify the Id of the organization to update it. All fields that are not readonly (readonly="false" in the table) are optional. Allowed for admins.

UPDATE Organizations SET Notes = 'Something interesting' WHERE Id = '123'

To make the same change to multiple organizations, use the following Sql statement:

UPDATE Organizations SET Notes = 'Something interesting' WHERE Id IN ('123', '456')

To make different changes to multiple organizations, see Batch Processing for an example.

Delete

You must specify the Id of the organization to delete it. Allowed for admins.

DELETE FROM Organizations WHERE Id = '123'

You can delete many organizations simultaneously by providing their ids:

DELETE FROM Organizations WHERE Id IN ('123', '456')

You can also delete many organizations simultaneously by using Batch Processing.

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned when the ticket is created.
Name	String	False		A unique name for the organization.
GroupId	Long	False	Groups.Id	New tickets from users in this organization are automatically put in this group.
ExternalId	Long	False		A unique external id to associate organizations to an external record.
CreatedAt	Datetime	True		The time the organization was created.
UpdatedAt	Datetime	True		The time of the last update of the organization.
DomainNames	String	False		An array of domain names associated with this organization.
Details	String	False		Any details obout the organization, such as the address.
Notes	String	False		Any notes you have about the organization.
SharedTickets	Boolean	False		End users in this organization are able to see tickets of each other.
SharedComments	Boolean	False		End users in this organization are able to see comments on tickets of each other.
Tags	String	False		The tags of the organization.
Url	String	True		The URL for this resource.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
UserId	Long	The user id used to query organizations

Create, delete, and query Organization Subscriptions in Zendesk.

Table Specific Information

Select

The following queries are processed server side while other filters are processed client side within the Cloud.

SELECT * FROM OrganizationSubscriptions WHERE Id = '123'

SELECT * FROM OrganizationSubscriptions WHERE UserId = '123'

SELECT * FROM OrganizationSubscriptions WHERE OrganizationId = '123'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Insert

The UserId and OrganizationId fields are required to insert. End users can only subscribe to shared organizations in which they're members. Allowed for agents and end users.

INSERT INTO OrganizationSubscriptions (UserId, OrganizationId) VALUES ('772', '881')

Delete

You must specify the Id of the subscription to delete it. Allowed for agents and end users.

DELETE FROM OrganizationSubscriptions WHERE Id = '123'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Organization subscription id.
OrganizationId	Long	False	Organizations.Id	.
UserId	Long	False		.
CreatedAt	Datetime	True		.
Url	String	True		The url of this resource.

Query, Insert, Update and Delete PostComments in Zendesk.

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned when the comment is created.
Url	String	True		The API url of the comment.
HtmlUrl	String	True		The community url of the comment.
Body	String	False		The comment made by the author.
AuthorId	Long	True		The id of the author of the comment. *Writable on create by Help Center managers.
PostId	Long	True	Posts.Id	The id of the post on which the comment was made.
Official	Boolean	False		Whether the comment is marked as official.
VoteSum	Integer	True		The sum of upvotes (+1) and downvotes (-1), which may be positive or negative.
VoteCount	Integer	True		The total number of upvotes and downvotes.
CreatedAt	Datetime	True		The time the post was created.
UpdatedAt	Datetime	True		The time of the last update of the post.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
FilterBy	String	May be planned, not_planned, completed, answered or none.

Queries, Inserts, Updates, and Deletes Posts in Zendesk.

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned when the post is created.
Url	String	True		The API url of the post.
HtmlUrl	String	True		The community url of the post.
Title	String	False		The title of the post.
Details	String	False		The details of the post.
AuthorId	Long	True		The Id of the author of the post. *Writable on create by Help Center managers.
Pinned	Boolean	False		When true, pins the post to the top of its topic.
Featured	Boolean	False		Whether the post is featured.
Closed	Boolean	False		Whether further comments are allowed.
Status	String	False		The status of the post. Possible values:
VoteSum	Integer	True		The sum of upvotes (+1) and downvotes (-1), which may be positive or negative.
VoteCount	Integer	True		The total number of upvotes and downvotes.
CommentCount	Integer	True		The number of comments on the post.
FollowerCount	Integer	True		The number of followers of the post.
TopicId	Long	False	Topics.Id	The Id of the topic that the post belongs to.
CreatedAt	Datetime	True		The time the post was created.
UpdatedAt	Datetime	True		The time of the last update of the post.
FilterBy	String	False		Possible values are planned, not_planned, completed, answered, or none.

Create and query Requests in Zendesk.

Table Specific Information

Select

The following queries are processed server side while other filters are processed client side within the Cloud.

SELECT * FROM SatisfactionRatings WHERE Id = '123'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Insert

The TicketId and Score fields are required to insert. Creates a CSAT rating for solved tickets, or for tickets that were previously solved and then reopened. Allowed for an end user who requested the ticket.

INSERT INTO SatisfactionRatings (TicketId, Score) VALUES ('12', 'good')

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Long	False		Automatically assigned upon creation.
TicketId	Integer	False	Tickets.Id	The id of ticket being rated.
Score	String	False		The rating: offered, unoffered, good or bad. When used in a filter it takes one of values: offered, unoffered, received, received_with_comment, received_without_comment, good, good_with_comment, good_without_comment, bad, bad_with_comment, bad_without_comment.
Comment	String	False		The comment received with this rating, if available.
Reason	String	False		The reason for a bad rating given by the requester in a follow-up question. Satisfaction reasons must be enabled.
AssigneeId	Long	False	Users.Id	The id of agent assigned to at the time of rating.
GroupId	Long	False	Groups.Id	The id of group assigned to at the time of rating.
RequesterId	Long	False	Users.Id	The id of ticket requester submitting the rating.
CreatedAt	Datetime	False		The time the satisfaction rating got created.
UpdatedAt	Datetime	False		The time the satisfaction rating got updated.
Url	String	False		The API url of this rating.
StartTime	Datetime	False		Time of the oldest satisfaction rating
EndTime	Datetime	False		Time of the most recent satisfaction rating

Create, update, delete and query Schedules in Zendesk.

Table Specific Information

Select

The following queries are processed server side while other filters are processed client side within the Cloud.

SELECT * FROM Schedules WHERE Id = '123'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Insert

The Name and TimeZone fields are required to insert. Allowed for admins.

INSERT INTO Schedules (Name, TimeZone) VALUES ('test', 'Eastern Time (US & Canada)')

Update

You must specify the Id of the schedule to update. Allowed for admins.

UPDATE Schedules SET Name = 'EMEA', TimeZone = 'London' WHERE Id = '123'

You can update the intervals of a Schedule by issuing a separate Update statement.

UPDATE Schedules SET Intervals = '[{\"start_time\": 3420, \"end_time\": 3900}]' WHERE Id = '123'

Delete

You must specify the Id of the macro to delete it. Allowed for agents.

DELETE FROM Schedules WHERE Id = '123'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned upon creation.
Name	String	False		Name of the schedule.
TimeZone	String	False		Time zone of the schedule.
Intervals	String	False		Array of intervals for the schedule.
CreatedAt	Datetime	True		Time the schedule was created.
UpdatedAt	Datetime	True		Time the schedule was last updated.

Create, update, delete, and query Sections in Zendesk.

Table Specific Information

Select

The following queries are processed server side while other filters are processed client side within the Cloud.

SELECT * FROM Sections
SELECT * FROM Sections WHERE Id = '13647896255645'
SELECT * FROM Sections WHERE Locale = 'en-us'
SELECT * FROM Sections WHERE Locale = 'en-us' AND Id = '13647896255645'
SELECT * FROM Sections WHERE CategoryId = '13625283663133'
SELECT * FROM Sections WHERE Locale = 'en-us' AND CategoryId = '13625283663133'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Insert

The Name and CategoryId columns are required to insert. All fields that are not readonly (readonly="false" in the table) are optional. Allowed for Agents.

INSERT INTO Sections (Name, CategoryId) VALUES ('Test CData', '13626588262429')

Update

You must specify the Id of the Section to update. It updates the section-level data such as Name, Description, Position, CategoryId, ParentSectionId and ThemeTemplate. All fields that are not readonly (readonly="false" in the table) are optional. Allowed for Help Center managers.

UPDATE Sections SET Name = 'UpdatedName' WHERE Id = '13647896255645'

Delete

You must specify the Id of the Section to delete it. Allowed for Help Center managers.

DELETE FROM Sections WHERE Id = '13647939064221'
DELETE FROM Sections WHERE Id = '13647939064221' AND Locale = 'en-us'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned when creating subscriptions.
CategoryId	Long	False		The id of the category to which this section belongs.
Name	String	False		The name of the section.
Description	String	False		The description of the section.
Locale	String	False		The locale in which the section is displayed.
ParentSectionId	Long	False		The id of the section to which this section belongs. Only writable for Guide Enterprise customers.
CreatedAt	Datetime	True		The time at which the section was created.
UpdatedAt	Datetime	True		The time at which the section was last updated.
Url	String	True		The API url of this section.
HtmlUrl	String	True		The url of this section in Help Center.
Outdated	Boolean	True		Whether the section is out of date.
Position	Integer	False		The position of this section in the section list. Used when sorting is set to manual. By default the section is added to the end of the list.
SourceLocale	String	True		The source (default) locale of the section.
ThemeTemplate	String	False		The theme template name used to display this section in Help Center.

Query and delete Sessions in Zendesk.

Table Specific Information

Select

The following queries are processed server side while other filters are processed client side within the Cloud.

SELECT * FROM Sessions WHERE Userid = '123'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Delete

You must specify the UserId and Id of the session to delete it. Allowed for admins, agents, end users.

DELETE FROM Sessions WHERE Userid = '123' AND Id = '456'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned when the session is created.
UserId	Long	True	Users.Id	The id of the user.
AuthenticatedAt	Datetime	True		When the session was created.
LastSeenAt	Datetime	True		The last approximate time this session was seen. This does not update on every request.
Url	String	True		The API URL of this session.

Create, update, delete, and query SharingAgreements in Zendesk.

Table Specific Information

Select

The following queries are processed server side while other filters are processed client side within the Cloud.

SELECT * FROM SharingAgreements WHERE Id = '123'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Insert

The RemoteSubdomain field is required to insert. Allowed for agents.

INSERT INTO SharingAgreements (RemoteSubdomain) VALUES ('Foo')

Update

You must specify the Id of the SharingAgreement to update. Only Status is allowed to be updated. Allowed for agents.

UPDATE SharingAgreements SET Status = 'accepted' WHERE Id = '123'

Delete

You must specify the Id of the SharingAgreement to delete it. Allowed for agents.

DELETE FROM SharingAgreements WHERE Id = '123'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned upon creation.
Name	String	False		Name of this sharing agreement.
Type	String	False		Can be one of the following: 'inbound', 'outbound'.
Status	String	False		Can be one of the following: 'accepted', 'declined', 'pending', 'inactive'.
PartnerName	String	False		Can be one of the following: 'jira', null.
RemoteSubdomain	String	False		Subdomain of the remote account or null if not associated with an account.
CreatedAt	Datetime	True		The time the record was created.

Create, update and query Side Conversations in Zendesk.

Table Specific Information

Select

The following queries are processed server side while other filters are processed client side within the Cloud.

At least TicketId is required in order to retrieve the SideConversations.

SELECT * FROM SideConversations WHERE TicketId = 1
SELECT * FROM SideConversations WHERE TicketId = 1 AND Id = '5d133b65-576c-11ee-bcb2-bdce8f618e59'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Insert

The Columns TicketId, Subject, PreviewText and Participants are required to insert. Allowed for Agents.

INSERT INTO SideConversationParticipants#temp(Email,Name) VALUES('[email protected]', 'someone')
INSERT INTO SideConversations(TicketId, Subject, PreviewText, Participants) VALUES(1, 'Test Subject', 'Test Body', 'SideConversationParticipants#temp')

You can also reply to a side conversation. The Columns Id, TicketId, Subject, PreviewText and Participants are required for Reply on a particular SideConversation. Allowed for Agents.

INSERT INTO SideConversationParticipants#temp(Email,Name) VALUES('[email protected]', 'someone')
INSERT INTO SideConversations(Id, TicketId, Subject, PreviewText, Participants) VALUES('5d133b65-576c-11ee-bcb2-bdce8f618e59', 2, 'Test Reply', 'Body for Reply message', 'SideConversationParticipants#temp')

Update

You must specify the TicketId and Id of the SideConversation to update. It only update the State and Subject columns. All fields that are not readonly (readonly="false" in the table) are optional. Allowed for Agents.

UPDATE SideConversations SET State='open' WHERE Id='5d133b65-576c-11ee-bcb2-bdce8f618e59' AND TicketId=1

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	False		Automatically assigned when the side conversation is created.
TicketId	Integer	False	Tickets.Id	The parent ticket id of the side conversation.
ExternalIds	String	False		A key-value store of metadata. All values must be strings.
Subject	String	False		The subject of the side conversation.
CreatedAt	Datetime	True		The time the side conversation was created.
UpdatedAt	Datetime	True		The time the side conversation was created.
MessageAddedAt	String	True		The time of the last message on the side conversation.
Participants	String	False		An array of participants in the side conversation.
PreviewText	String	False		A plain text text describing the side conversation.
State	String	False		The state of the side conversation.
StateUpdatedAt	String	True		The time of the update of the state of the side conversation.
Url	String	True		The API url of the side conversation.

Create, update, delete, and query SlaPolicies in Zendesk.

Table Specific Information

Select

The following queries are processed server side while other filters are processed client side within the Cloud.

SELECT * FROM SlaPolicies
SELECT * FROM SlaPolicies WHERE Id = '18393257431953'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Insert

The Title field and atleast one field from either FilterAll or FilterAny is required to insert. A suitable combination of Field, Operator and Value is required for insertion in FilterAll and FilterAny. Here is a list of the possible combinations: "https://developer.zendesk.com/documentation/ticketing/reference-guides/conditions-reference/#shared-conditions". Allowed for admins.

INSERT INTO SlaPoliciesFilterAll#temp(Field, Operator, Value) VALUES('type', 'is', 'incident')
INSERT INTO SlaPoliciesFilterAny#temp(Field, Operator, Value) VALUES('type', 'is', 'problem')
INSERT INTO SlaPolicies(Title, Description, FilterAll, FilterAny) values('Test', 'This is the test description', 'SlaPoliciesFilterAll#temp', 'SlaPoliciesFilterAny#temp')

Update

You must specify the Id of the SlaPolicies to update it. FilterAll and FilterAny aggregate columns support duplicate values in the object, so in order to update these fields, you must specifty the whole aggregate object. All fields that are not readonly (readonly="false" in the table) are optional. Allowed for admins.

INSERT INTO SlaPoliciesFilterAll#temp(Field, Operator, Value) Values('type', 'is', 'task')
INSERT INTO SlaPoliciesFilterAll#temp(Field, Operator, Value) Values('type', 'is', 'incident')
INSERT INTO SlaPoliciesFilterAll#temp(Field, Operator, Value) Values('group_id', 'is', '18285074736529')
UPDATE SlaPolicies SET Title='Updated Title', FilterAll='SlaPoliciesFilterAll#temp' WHERE Id = '18393257431953'

Delete

You must specify the Id of the group to delete it. Allowed for admins.

DELETE FROM SlaPolicies WHERE Id=18392949131793

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned.
Title	String	False		The title of the SLA policy.
Description	String	False		The description of the SLA policy.
CreatedAt	Datetime	True		When this locale was created.
UpdatedAt	Datetime	True		When this locale last got updated.
Position	Integer	True		Position of the SLA policy, determines the order they will be matched. If not specified, SLA Policy is added as the last position.
FilterAll	String	False		An object that describes the conditions that a ticket must match in order for an SLA policy to be applied to that ticket.
FilterAny	String	False		An object that describes the conditions that a ticket must match in order for an SLA policy to be applied to that ticket.
PolicyMetrics	String	False		An object that describes the metric targets for each value of the priority field.

Create, update, delete, and query Support Addresses in Zendesk.

Table Specific Information

Select

The following queries are processed server side while other filters are processed client side within the Cloud.

SELECT * FROM SupportAddresses WHERE Id = '123'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Insert

The Email field is required to insert (only adding a Zendesk support address to your account is supported). To add a Zendesk address, use the following syntax: {local-part}@{accountname}.zendesk.com. Example: '[email protected]'. The local-part can be anything you like. Allowed for admins.

INSERT INTO SupportAddresses  (Email) VALUES ('[email protected]')

Update

You must specify the Id of the support address to update. Allowed for admins.

UPDATE SupportAddresses SET Name = 'Sales' WHERE Id = '123'

Delete

You must specify the Id of the support address to delete it. Allowed for admins.

DELETE FROM SupportAddresses WHERE Id = '123'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned when created.
Name	String	False		The name for the address.
Email	String	False		The email address (not updateable).
CreatedAt	Datetime	True		The time the brand was created.
UpdatedAt	Datetime	True		The time of the last update of the brand.
Default	Boolean	False		Whether the address is the account's default support address.
BrandId	Long	False	Brands.Id	The id of the brand.
ForwardingStatus	String	True		Possible values: unknown, waiting, verified, or failed.
SpfStatus	String	True		Possible values: unknown, verified, failed.

Query and delete Suspended Tickets in Zendesk.

Table Specific Information

Select

The following queries are processed server side while other filters are processed client side within the Cloud.

SELECT * FROM SuspendedTickets WHERE Id = '123'

SELECT * FROM SuspendedTickets ORDER BY AuthorEmail

SELECT * FROM SuspendedTickets ORDER BY Cause

SELECT * FROM SuspendedTickets ORDER BY Subject

SELECT * FROM SuspendedTickets ORDER BY CreatedAt

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Delete

You must specify the Id of the suspended ticket to delete it. Allowed for unrestricted agents.

DELETE FROM SuspendedTickets WHERE Id = '123'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned when the ticket is created.
TicketId	Integer	True	Tickets.Id	The ticket ID this suspended email is associated with, if available.
MessageId	String	True		The ID of the email, if available.
BrandId	Long	True	Brands.Id	The id of the brand this ticket is associated with - only applicable for enterprise accounts.
Recipient	String	True		The original recipient e-mail address of the ticket.
Subject	String	True		The value of the subject field for this ticket.
Content	String	True		The content that was flagged.
AuthorId	Long	True		The id of author.
AuthorName	String	True		The name of author.
AuthorEmail	String	True		The email of author.
Cause	String	True		Why the ticket was suspended.
CreatedAt	Datetime	True		When this record was created.
UpdatedAt	Datetime	True		When this record last got updated.
ViaChannel	String	True		.
ViaSourceFromId	Long	True		.
ViaSourceFromTitle	String	True		.
ViaSourceTo	String	True		.
ViaSourceRel	String	True		.
Url	String	True		The API url of this ticket.

Query TicketAudits in Zendesk.

Table Specific Information

Select

The following queries are processed server side while other filters are processed client side within the Cloud.

SELECT * FROM TicketAudits WHERE TicketId = '123'

SELECT * FROM TicketAudits WHERE TicketId = '123' AND Id = '456'

To get the TicketIds of deleted tickets run this query:

GETDELETED FROM TicketAudits

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Long	False		Automatically assigned when creating audits.
TicketId	Integer	False	Tickets.Id	The ID of the associated ticket.
AuthorId	Long	False	Users.Id	The user who created the audit.
CreatedAt	Datetime	False		The time the audit was created.
Metadata	String	False		Metadata for the audit, custom and system data.
ViaChannel	String	False		This object explains how this audit was created. This does not update on every request.
ViaSource	String	False		This object explains how this audit was created. This does not update on every request.
Events	String	False		The Array of Events that happened in this Audit.

Query TicketComments belonging to a specified ticket in Zendesk.

Table Specific Information

Select

The Ticket Id is required to query this view. The following queries are processed server side.

SELECT * FROM TicketComments WHERE TicketId = '123'

To get the TicketIds of deleted tickets run this query:

GETDELETED FROM TicketComments

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Long	False		Automatically assigned when the ticket is created.
TicketId	Integer	False	Tickets.Id	The id of the ticket the comment belongs to.
AuthorId	Long	False	Users.Id	The id of the comment author.
Type	String	False		Comment or VoiceComment.
Body	String	False		The comment string.
CreatedAt	Datetime	False		The time the comment was created.
HtmlBody	String	False		The comment formatted as HTML.
PlainBody	String	False		The comment as plain text.
IsPublic	Boolean	False		True if a public comment; false if an internal note. The initial value set on ticket creation persists for any additional comment unless you change it.
ViaChannel	String	False		This tells you how the ticket or event was created. Examples: 'web', 'mobile', 'rule', 'system'.
ViaSource	String	False		.
MetadataCustom	String	False		.
MetadataSystemClient	String	False		.
MetadataSystemIpAddres	String	False		.
MetadataSystemLatitude	String	False		.
MetadataSystemLongitude	String	False		.
MetadataSystemLocation	String	False		.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
UpdatedAt	Datetime	The time of the comment was updated.
ReferenceNumber	String	Reference number which can be use while doing temp table insertion.

Query TicketEvents in Zendesk.

Table Specific Information

Select

The following queries are processed server side while other filters are processed client side within the Cloud.

SELECT * FROM TicketEvents
SELECT * FROM TicketEvents WHERE StartTime = '2023-10-11'
SELECT * FROM TicketEvents WHERE StartTime = '2023-10-11' AND Include = true
SELECT * FROM TicketEvents WHERE Include = true

To get the TicketIds of deleted tickets run this query:

GETDELETED FROM TicketEvents

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Long	False		Automatically assigned when Ticket Event is created.
TicketId	Integer	False	Tickets.Id	The ticket Id.
ChildEvents	String	False		Array of the Child Events.
UpdaterId	Long	False		Updater Id.
Timestamp	String	False		Timestamp at which event is created.
Via	String	False		The medium through which event is created.
SystemClient	String	False		System client information.
SystemLocation	String	False		System location information.
SystemLatitude	String	False		System latitude information.
SystemLongitude	String	False		System longitude information.
EventType	String	False		Type of the Event.
CreatedAt	Datetime	False		When this record was created.
Metadata	String	False		The metadata of the event.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
StartTime	Datetime	The time to start the incremental export from. Must be at least one minute in the past. If not provided, it will take the starttime for the most recent minute.
Include	Boolean	If true, it will include the comments in the event stream. By default, value is false.

Create, update, delete, and query TicketFields in Zendesk.

Table Specific Information

Select

The following queries are processed server side while other filters are processed client side within the Cloud.

SELECT * FROM TicketFields WHERE Id = '123'

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Insert

The Type and Title fields are required to insert. Allowed for admins.

INSERT INTO TicketFields (Type, Title) VALUES ('text', 'Age')

To insert a ticket field of type tagger (dropdown) or multiselect (dropdown), CustomFieldOptions is also required. Allowed for admins.

INSERT INTO TicketFields (Type, Title, CustomFieldOptions) VALUES ('tagger', 'TestDropdown', '[{\"name\": \"Apple Pie\", \"value\": \"apple\"}, {\"name\": \"Pecan Pie\", \"value\": \"pecan\"}]')

To insert a ticket field of type regexp, RegexpForValidation is also required. Allowed for admins.

INSERT INTO TicketFields (Type, Title, RegexpForValidation) VALUES ('regexp', 'TestRegExp', '\\b([0-9]{4})-(1[0-2]|0?[1-9])-(3[0-1]|[1-2][0-9]|0?[1-9])\\b')

You can also create a Lookup Relationships. A lookup relationship field is a custom field whose type is "lookup". This type of custom field gives you the ability to create a relationship from a source object to a target object. To create a lookup relationship fields, Type and RelationshipTargetType columns are required. The Type column value must be "lookup". A suitable combination of Field, Operator and Value is required for insertion in RelationshipFilterAll and RelationshipFilterAny. Here is a list of the possible combinations: "https://developer.zendesk.com/documentation/ticketing/reference-guides/conditions-reference/#shared-conditions".

INSERT INTO TicketFieldsRelationshipFilterAll#temp(Field, Operator, Value) VALUES('role', 'is', 'Agent')
INSERT INTO TicketFieldsRelationshipFilterAny#temp(Field, Operator, Value) VALUES('role', 'is', 'Agent')
INSERT INTO TicketFields (Type, Title, RelationshipTargetType, RelationshipFilterAll, RelationshipFilterAny) VALUES ('lookup', 'Lookup Relationships', 'zen:user', 'TicketFieldsRelationshipFilterAll#temp', 'TicketFieldsRelationshipFilterAny#temp')

Update

You must specify the Id of the ticket field to update. All fields that are not readonly (readonly="false" in the table) are optional. Allowed for admins.

UPDATE TicketFields SET Title = 'Your age' WHERE Id = '123'

For a ticket field of type tagger (dropdown) or multiselect (dropdown), use the CustomFieldOptions column to update the options. For type regexp use RegexpForValidation to update the regular expression.

Delete

You must specify the Id of the ticket field to delete it. Allowed for admins.

DELETE FROM TicketFields WHERE Id = '123'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Automatically assigned when the ticket is created.
Type	String	False		The type of the ticket field: checkbox, date, decimal, integer, regexp, tagger, text, or textarea. Type is not editable once created.
Title	String	False		The title of the ticket field.
RawTitle	String	False		The dynamic content placeholder, if present, or the 'title' value, if not.
Description	String	False		The description of the purpose of this ticket field, shown to users.
RawDescription	String	False		The dynamic content placeholder, if present, or the 'description' value, if not.
Position	Integer	False		A relative position for the ticket fields that determines the order of ticket fields on a ticket. Note that positions 0 to 7 are reserved for system fields.
Active	Boolean	False		Whether this field is available.
Required	Boolean	False		Whether this field is available.
CollapsedForAgents	Boolean	False		If this field should be shown to agents by default or be hidden alongside infrequently used fields. Classic interface only.
RegexpForValidation	String	False		Regular expression field only. The validation pattern for a field value to be deemed valid.
TitleInPortal	String	False		The title of the ticket field when shown to end users.
RawTitleInPortal	String	False		The dynamic content placeholder, if present, or the 'title_in_portal' value, if not.
VisibleInPortal	Boolean	False		Whether this field is available to end users.
EditableInPortal	Boolean	False		Whether this field is editable by end users.
Tag	String	False		A tag value to set for checkbox fields when checked.
CreatedAt	Datetime	True		The time the ticket field was created.
UpdatedAt	Datetime	True		The time of the last update of the ticket field.
SystemFieldOptions	String	True		Presented for a ticket field of type 'tickettype', 'priority' or 'status'.
CustomFieldOptions	String	False		Required and presented for a ticket field of type 'tagger'.
Removable	Boolean	True		If this field is not a system basic field that must be present for all tickets on the account.
Url	String	True		The URL for this resource.
AgentDescription	String	False		A description of the ticket field that only agents can see.
CustomStatuses	String	True		List of customized ticket statuses. Only presented for a system ticket field of type custom_status.
RelationshipFilterAll	String	False		A filter definition that allows your autocomplete to filter down results with Logical AND.
RelationshipFilterAny	String	False		A filter definition that allows your autocomplete to filter down results with Logical OR.
RelationshipTargetType	String	False		A representation of what type of object the field references. Options are zen:user, zen:organization, zen:ticket, or zen:custom_object:CUSTOM_OBJECT_KEY. For example zen:custom_object:apartment.
RequiredInPortal	String	False		If true, end users must enter a value in the field to create the request.
SubTypeId	String	False		For system ticket fields of type priority and status. Defaults to 0. A priority sub type of 1 removes the Low and Urgent options. A status sub type of 1 adds the On-Hold option.

Create, update, delete, and query Ticket Forms in Zendesk.

Table Specific Information

Select

The following queries are processed server side while other filters are processed client side within the Cloud.

SELECT * FROM TicketForms WHERE Id = '123'

SELECT * FROM TicketForms WHERE Id IN ('123', '456')

SELECT * FROM TicketForms WHERE Active = true

SELECT * FROM TicketForms WHERE EndUserVisible = true

SELECT * FROM TicketForms WHERE FallbackToDefault = true

SELECT * FROM TicketForms WHERE AssociatedToBrand = true

You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.

Insert

The Name field is required to insert. Allowed for admins.

INSERT INTO TicketForms (Name, EndUserVisible, DisplayName, Position, Active, Default) VALUES ('Snowboard Problem', true, 'Snowboard Damage' 2, true, false)

Update

You must specify the Id of the ticket form to update it. All fields that are not readonly (readonly="false" in the table) are optional. Allowed for admins.

UPDATE TicketForms SET Name = 'Snowboard Fixed', DisplayName = 'Snowboard has been fixed' WHERE Id = '123'

Delete

You must specify the Id of the ticket form to delete it. Allowed for admins.

DELETE FROM TicketForms WHERE Id = '123'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Ticket form id.
Name	String	False		The name of the form.
RawName	String	False		The dynamic content placeholder, if present, or the 'name' value, if not.
DisplayName	String	False		The name of the form that is displayed to an end user.
RawDisplayName	String	False		The dynamic content placeholder, if present, or the 'display_name' value, if not.
Position	Integer	False		The position of this form among other forms in the account, i.e. dropdown.
Active	Boolean	False		If the form is set as active.
EndUserVisible	Boolean	False		Is the form visible to the end user.
Default	Boolean	False		Is the form the default form for this account.
TicketFieldIds	String	False		Ids of all ticket fields which are in this ticket form.
InAllBrands	Boolean	False		Is the form available for use in all brands on this account.
RestrictedBrandIds	String	False		Ids of all brands that this ticket form is restricted to.
CreatedAt	Datetime	True		The time the ticket form was created.
UpdatedAt	Datetime	True		The time of the last update of the ticket form.
AgentConditions	String	False		Array of condition sets for agent workspaces.
EndUserConditions	String	False		Array of condition sets for end user products.
Url	String	True		URL of the ticket form.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
FallbackToDefault	Boolean	If true, returns default ticket form when the criteria defined by the parameters results in a set without active and end user visible ticket forms.
AssociatedToBrand	Boolean	Only ticket forms of current brand (defined by url) if true.