Zendesk

Since Camel 2.19

Both producer and consumer are supported

The Zendesk component provides access to all of the zendesk.com APIs accessible using zendesk-java-client. It allows producing messages to manage Zendesk ticket, user, organization, etc.

Maven users will need to add the following dependency to their pom.xml for this component:

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-zendesk</artifactId>
    <version>${camel-version}</version>
</dependency>

Configuring Options

Camel components are configured on two separate levels:

  • component level

  • endpoint level

Configuring Component Options

The component level is the highest level which holds general and common configurations that are inherited by the endpoints. For example a component may have security settings, credentials for authentication, urls for network connection and so forth.

Some components only have a few options, and others may have many. Because components typically have pre configured defaults that are commonly used, then you may often only need to configure a few options on a component; or none at all.

Configuring components can be done with the Component DSL, in a configuration file (application.properties|yaml), or directly with Java code.

Configuring Endpoint Options

Where you find yourself configuring the most is on endpoints, as endpoints often have many options, which allows you to configure what you need the endpoint to do. The options are also categorized into whether the endpoint is used as consumer (from) or as a producer (to), or used for both.

Configuring endpoints is most often done directly in the endpoint URI as path and query parameters. You can also use the Endpoint DSL and DataFormat DSL as a type safe way of configuring endpoints and data formats in Java.

A good practice when configuring options is to use Property Placeholders, which allows to not hardcode urls, port numbers, sensitive information, and other settings. In other words placeholders allows to externalize the configuration from your code, and gives more flexibility and reuse.

The following two sections lists all the options, firstly for the component followed by the endpoint.

Component Options

The Zendesk component supports 10 options, which are listed below.

Name Description Default Type

serverUrl (common)

The server URL to connect.

String

bridgeErrorHandler (consumer)

Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored.

false

boolean

lazyStartProducer (producer)

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

boolean

autowiredEnabled (advanced)

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

boolean

configuration (advanced)

Component configuration.

ZendeskConfiguration

zendesk (advanced)

To use a shared Zendesk instance.

Zendesk

oauthToken (security)

The OAuth token.

String

password (security)

The password.

String

token (security)

The security token.

String

username (security)

The user name.

String

Endpoint Options

The Zendesk endpoint is configured using URI syntax:

zendesk:methodName

with the following path and query parameters:

Path Parameters (1 parameters)

Name Description Default Type

methodName (common)

Required What operation to use.

Enum values:

  • ADD_TAG_TO_ORGANISATIONS

  • ADD_TAG_TO_TICKET

  • ADD_TAG_TO_TOPICS

  • ASSOCIATE_ATTACHMENTS_TO_ARTICLE

  • CHANGE_USER_PASSWORD

  • CREATE_ARTICLE

  • CREATE_ARTICLE_1

  • CREATE_ARTICLE_TRANSLATION

  • CREATE_AUTOMATION

  • CREATE_CATEGORY

  • CREATE_CATEGORY_TRANSLATION

  • CREATE_COMMENT

  • CREATE_DYNAMIC_CONTENT_ITEM

  • CREATE_DYNAMIC_CONTENT_ITEM_VARIANT

  • CREATE_FORUM

  • CREATE_GROUP

  • CREATE_GROUP_MEMBERSHIP

  • CREATE_GROUP_MEMBERSHIP_1

  • CREATE_MACRO

  • CREATE_OR_UPDATE_USER

  • CREATE_OR_UPDATE_USERS

  • CREATE_OR_UPDATE_USERS_1

  • CREATE_OR_UPDATE_USERS_ASYNC

  • CREATE_ORGANIZATION

  • CREATE_ORGANIZATION_MEMBERSHIP

  • CREATE_ORGANIZATION_MEMBERSHIP_1

  • CREATE_ORGANIZATION_MEMBERSHIPS

  • CREATE_ORGANIZATION_MEMBERSHIPS_1

  • CREATE_ORGANIZATION_MEMBERSHIPS_ASYNC

  • CREATE_ORGANIZATIONS

  • CREATE_ORGANIZATIONS_1

  • CREATE_ORGANIZATIONS_ASYNC

  • CREATE_PERMISSION_GROUP

  • CREATE_REQUEST

  • CREATE_SATISFACTION_RATING

  • CREATE_SATISFACTION_RATING_1

  • CREATE_SECTION

  • CREATE_SECTION_TRANSLATION

  • CREATE_TARGET

  • CREATE_TICKET

  • CREATE_TICKET_ASYNC

  • CREATE_TICKET_FIELD

  • CREATE_TICKET_FORM

  • CREATE_TICKET_FROM_TWEET

  • CREATE_TICKETS

  • CREATE_TICKETS_1

  • CREATE_TICKETS_ASYNC

  • CREATE_TOPIC

  • CREATE_TRIGGER

  • CREATE_UPLOAD

  • CREATE_UPLOAD_1

  • CREATE_UPLOAD_2

  • CREATE_UPLOAD_ARTICLE

  • CREATE_UPLOAD_ARTICLE_1

  • CREATE_USER

  • CREATE_USER_IDENTITY

  • CREATE_USER_IDENTITY_1

  • CREATE_USER_SEGMENT

  • CREATE_USERS

  • CREATE_USERS_1

  • CREATE_USERS_ASYNC

  • DELETE_ARTICLE

  • DELETE_ARTICLE_ATTACHMENT

  • DELETE_ARTICLE_ATTACHMENT_1

  • DELETE_ATTACHMENT

  • DELETE_ATTACHMENT_1

  • DELETE_AUTOMATION

  • DELETE_CATEGORY

  • DELETE_DYNAMIC_CONTENT_ITEM

  • DELETE_DYNAMIC_CONTENT_ITEM_VARIANT

  • DELETE_FORUM

  • DELETE_GROUP

  • DELETE_GROUP_1

  • DELETE_GROUP_MEMBERSHIP

  • DELETE_GROUP_MEMBERSHIP_1

  • DELETE_GROUP_MEMBERSHIP_2

  • DELETE_GROUP_MEMBERSHIP_3

  • DELETE_ORGANIZATION

  • DELETE_ORGANIZATION_1

  • DELETE_ORGANIZATION_MEMBERSHIP

  • DELETE_ORGANIZATION_MEMBERSHIP_1

  • DELETE_ORGANIZATION_MEMBERSHIP_2

  • DELETE_ORGANIZATION_MEMBERSHIPS

  • DELETE_PERMISSION_GROUP

  • DELETE_PERMISSION_GROUP_1

  • DELETE_SECTION

  • DELETE_SUSPENDED_TICKET

  • DELETE_SUSPENDED_TICKET_1

  • DELETE_TARGET

  • DELETE_TICKET

  • DELETE_TICKET_1

  • DELETE_TICKET_FIELD

  • DELETE_TICKET_FIELD_1

  • DELETE_TICKET_FORM

  • DELETE_TICKET_FORM_1

  • DELETE_TICKETS

  • DELETE_TOPIC

  • DELETE_TRANSLATION

  • DELETE_TRANSLATION_1

  • DELETE_TRIGGER

  • DELETE_UPLOAD

  • DELETE_UPLOAD_1

  • DELETE_USER

  • DELETE_USER_1

  • DELETE_USER_IDENTITY

  • DELETE_USER_IDENTITY_1

  • DELETE_USER_IDENTITY_2

  • DELETE_USER_SEGMENT

  • DELETE_USER_SEGMENT_1

  • GET_ACTIVE_TRIGGERS

  • GET_ARTICLE

  • GET_ARTICLE_FROM_SEARCH

  • GET_ARTICLE_FROM_SEARCH_1

  • GET_ARTICLE_SUBSCRIPTIONS

  • GET_ARTICLE_SUBSCRIPTIONS_1

  • GET_ARTICLE_TRANSLATIONS

  • GET_ARTICLES

  • GET_ARTICLES_1

  • GET_ARTICLES_2

  • GET_ARTICLES_3

  • GET_ARTICLES_FROM_ALL_LABELS

  • GET_ARTICLES_FROM_ANY_LABELS

  • GET_ARTICLES_FROM_PAGE

  • GET_ARTICLES_INCREMENTALLY

  • GET_ASSIGNABLE_GROUP_MEMBERSHIPS

  • GET_ASSIGNABLE_GROUP_MEMBERSHIPS_1

  • GET_ASSIGNABLE_GROUPS

  • GET_ASSIGNED_TICKETS_COUNT_FOR_USER

  • GET_ATTACHMENT

  • GET_ATTACHMENT_1

  • GET_ATTACHMENTS_FROM_ARTICLE

  • GET_AUTHENTICATED_USER

  • GET_AUTO_COMPLETE_ORGANIZATIONS

  • GET_AUTOMATION

  • GET_AUTOMATIONS

  • GET_BRANDS

  • GET_CC_REQUESTS

  • GET_CATEGORIES

  • GET_CATEGORY

  • GET_CATEGORY_TRANSLATIONS

  • GET_CCD_TICKETS_COUNT_FOR_USER

  • GET_COMPLIANCE_DELETION_STATUSES

  • GET_CURRENT_USER

  • GET_CUSTOM_AGENT_ROLES

  • GET_DELETED_TICKETS

  • GET_DELETED_TICKETS_1

  • GET_DYNAMIC_CONTENT_ITEM

  • GET_DYNAMIC_CONTENT_ITEM_VARIANT

  • GET_DYNAMIC_CONTENT_ITEM_VARIANTS

  • GET_DYNAMIC_CONTENT_ITEMS

  • GET_FORUM

  • GET_FORUMS

  • GET_FORUMS_1

  • GET_GROUP

  • GET_GROUP_MEMBERSHIP

  • GET_GROUP_MEMBERSHIP_1

  • GET_GROUP_MEMBERSHIP_BY_USER

  • GET_GROUP_MEMBERSHIPS

  • GET_GROUP_MEMBERSHIPS_1

  • GET_GROUP_ORGANIZATION

  • GET_GROUP_USERS

  • GET_GROUPS

  • GET_HELP_CENTER_LOCALES

  • GET_HOLIDAYS_FOR_SCHEDULE

  • GET_HOLIDAYS_FOR_SCHEDULE_1

  • GET_INCREMENTAL_TICKETS_RESULT

  • GET_JOB_STATUS

  • GET_JOB_STATUS_ASYNC

  • GET_JOB_STATUSES

  • GET_JOB_STATUSES_ASYNC

  • GET_MACRO

  • GET_MACROS

  • GET_OPEN_REQUESTS

  • GET_ORGANIZATION

  • GET_ORGANIZATION_FIELDS

  • GET_ORGANIZATION_MEMBERSHIP

  • GET_ORGANIZATION_MEMBERSHIP_BY_USER

  • GET_ORGANIZATION_MEMBERSHIP_FOR_USER

  • GET_ORGANIZATION_MEMBERSHIPS

  • GET_ORGANIZATION_MEMBERSHIPS_FOR_ORG

  • GET_ORGANIZATION_MEMBERSHIPS_FOR_USER

  • GET_ORGANIZATION_REQUESTS

  • GET_ORGANIZATION_TICKETS

  • GET_ORGANIZATION_USERS

  • GET_ORGANIZATIONS

  • GET_ORGANIZATIONS_1

  • GET_ORGANIZATIONS_INCREMENTALLY

  • GET_PERMISSION_GROUP

  • GET_PERMISSION_GROUPS

  • GET_RECENT_TICKETS

  • GET_REQUEST

  • GET_REQUEST_COMMENT

  • GET_REQUEST_COMMENT_1

  • GET_REQUEST_COMMENT_2

  • GET_REQUEST_COMMENTS

  • GET_REQUEST_COMMENTS_1

  • GET_REQUESTS

  • GET_SATISFACTION_RATING

  • GET_SATISFACTION_RATINGS

  • GET_SCHEDULE

  • GET_SCHEDULE_1

  • GET_SCHEDULES

  • GET_SEARCH_TICKET_RESULTS

  • GET_SECTION

  • GET_SECTION_SUBSCRIPTIONS

  • GET_SECTION_SUBSCRIPTIONS_1

  • GET_SECTION_TRANSLATIONS

  • GET_SECTIONS

  • GET_SECTIONS_1

  • GET_SECTIONS_2

  • GET_SOLVED_REQUESTS

  • GET_SUSPENDED_TICKETS

  • GET_TARGET

  • GET_TARGETS

  • GET_TICKET

  • GET_TICKET_AUDIT

  • GET_TICKET_AUDIT_1

  • GET_TICKET_AUDIT_2

  • GET_TICKET_AUDITS

  • GET_TICKET_AUDITS_1

  • GET_TICKET_COLLABORATORS

  • GET_TICKET_COMMENTS

  • GET_TICKET_COMMENTS_1

  • GET_TICKET_FIELD

  • GET_TICKET_FIELDS

  • GET_TICKET_FORM

  • GET_TICKET_FORMS

  • GET_TICKET_INCIDENTS

  • GET_TICKET_METRIC

  • GET_TICKET_METRIC_BY_TICKET

  • GET_TICKET_METRICS

  • GET_TICKETS

  • GET_TICKETS_1

  • GET_TICKETS_BY_EXTERNAL_ID

  • GET_TICKETS_BY_EXTERNAL_ID_1

  • GET_TICKETS_COUNT

  • GET_TICKETS_COUNT_FOR_ORGANIZATION

  • GET_TICKETS_FROM_SEARCH

  • GET_TICKETS_INCREMENTALLY

  • GET_TICKETS_INCREMENTALLY_1

  • GET_TOPIC

  • GET_TOPICS

  • GET_TOPICS_1

  • GET_TOPICS_2

  • GET_TOPICS_3

  • GET_TOPICS_BY_USER

  • GET_TRIGGER

  • GET_TRIGGERS

  • GET_TRIGGERS_1

  • GET_TWITTER_MONITORS

  • GET_USER

  • GET_USER_CCD_TICKETS

  • GET_USER_FIELDS

  • GET_USER_IDENTITIES

  • GET_USER_IDENTITIES_1

  • GET_USER_IDENTITY

  • GET_USER_IDENTITY_1

  • GET_USER_IDENTITY_2

  • GET_USER_RELATED_INFO

  • GET_USER_REQUESTED_TICKETS

  • GET_USER_REQUESTS

  • GET_USER_REQUESTS_1

  • GET_USER_SEGMENT

  • GET_USER_SEGMENTS

  • GET_USER_SEGMENTS_1

  • GET_USER_SEGMENTS_APPLICABLE

  • GET_USER_SUBSCRIPTIONS

  • GET_USER_SUBSCRIPTIONS_1

  • GET_USERS

  • GET_USERS_1

  • GET_USERS_BY_EXTERNAL_IDS

  • GET_USERS_BY_ROLE

  • GET_USERS_INCREMENTALLY

  • GET_VIEW

  • GET_VIEWS

  • IMPORT_TICKET

  • IMPORT_TOPIC

  • LOOKUP_ORGANIZATIONS_BY_EXTERNAL_ID

  • LOOKUP_USER_BY_EMAIL

  • LOOKUP_USER_BY_EXTERNAL_ID

  • MACROS_SHOW_CHANGES_TO_TICKET

  • MACROS_SHOW_TICKET_AFTER_CHANGES

  • MAKE_PRIVATE_TICKET_AUDIT

  • MAKE_PRIVATE_TICKET_AUDIT_1

  • MAKE_PRIVATE_TICKET_AUDIT_2

  • MARK_TICKET_AS_SPAM

  • MARK_TICKET_AS_SPAM_1

  • MERGE_USERS

  • NOTIFY_APP

  • PERMANENTLY_DELETE_TICKET

  • PERMANENTLY_DELETE_TICKET_1

  • PERMANENTLY_DELETE_TICKETS

  • PERMANENTLY_DELETE_USER

  • PERMANENTLY_DELETE_USER_1

  • QUEUE_CREATE_TICKET_ASYNC

  • REMOVE_TAG_FROM_ORGANISATIONS

  • REMOVE_TAG_FROM_TICKET

  • REMOVE_TAG_FROM_TOPICS

  • REQUEST_VERIFY_USER_IDENTITY

  • REQUEST_VERIFY_USER_IDENTITY_1

  • REQUEST_VERIFY_USER_IDENTITY_2

  • RESET_USER_PASSWORD

  • RESET_USER_PASSWORD_1

  • SEARCH_TRIGGERS

  • SEARCH_TRIGGERS_1

  • SET_GROUP_MEMBERSHIP_AS_DEFAULT

  • SET_ORGANIZATION_MEMBERSHIP_AS_DEFAULT

  • SET_TAG_ON_ORGANISATIONS

  • SET_TAG_ON_TICKET

  • SET_TAG_ON_TOPICS

  • SET_USER_PRIMARY_IDENTITY

  • SET_USER_PRIMARY_IDENTITY_1

  • SET_USER_PRIMARY_IDENTITY_2

  • SUSPEND_USER

  • TRUST_TICKET_AUDIT

  • TRUST_TICKET_AUDIT_1

  • TRUST_TICKET_AUDIT_2

  • UNSUSPEND_USER

  • UPDATE_ARTICLE

  • UPDATE_ARTICLE_TRANSLATION

  • UPDATE_AUTOMATION

  • UPDATE_CATEGORY

  • UPDATE_CATEGORY_TRANSLATION

  • UPDATE_DYNAMIC_CONTENT_ITEM

  • UPDATE_DYNAMIC_CONTENT_ITEM_VARIANT

  • UPDATE_FORUM

  • UPDATE_GROUP

  • UPDATE_INSTALLATION

  • UPDATE_MACRO

  • UPDATE_ORGANIZATION

  • UPDATE_ORGANIZATIONS

  • UPDATE_ORGANIZATIONS_1

  • UPDATE_ORGANIZATIONS_ASYNC

  • UPDATE_PERMISSION_GROUP

  • UPDATE_REQUEST

  • UPDATE_SECTION

  • UPDATE_SECTION_TRANSLATION

  • UPDATE_TICKET

  • UPDATE_TICKET_FIELD

  • UPDATE_TICKET_FORM

  • UPDATE_TICKETS

  • UPDATE_TICKETS_1

  • UPDATE_TICKETS_ASYNC

  • UPDATE_TOPIC

  • UPDATE_TRIGGER

  • UPDATE_USER

  • UPDATE_USER_IDENTITY

  • UPDATE_USER_IDENTITY_1

  • UPDATE_USER_SEGMENT

  • UPDATE_USERS

  • UPDATE_USERS_1

  • UPDATE_USERS_ASYNC

  • VERIFY_USER_IDENTITY

  • VERIFY_USER_IDENTITY_1

  • VERIFY_USER_IDENTITY_2

ZendeskApiMethod

Query Parameters (26 parameters)

Name Description Default Type

inBody (common)

Sets the name of a parameter to be passed in the exchange In Body.

String

serverUrl (common)

The server URL to connect.

String

sendEmptyMessageWhenIdle (consumer)

If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.

false

boolean

bridgeErrorHandler (consumer (advanced))

Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored.

false

boolean

exceptionHandler (consumer (advanced))

To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored.

ExceptionHandler

exchangePattern (consumer (advanced))

Sets the exchange pattern when the consumer creates an exchange.

Enum values:

  • InOnly

  • InOut

  • InOptionalOut

ExchangePattern

pollStrategy (consumer (advanced))

A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.

PollingConsumerPollStrategy

lazyStartProducer (producer (advanced))

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

boolean

backoffErrorThreshold (scheduler)

The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.

int

backoffIdleThreshold (scheduler)

The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.

int

backoffMultiplier (scheduler)

To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.

int

delay (scheduler)

Milliseconds before the next poll.

500

long

greedy (scheduler)

If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.

false

boolean

initialDelay (scheduler)

Milliseconds before the first poll starts.

1000

long

repeatCount (scheduler)

Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever.

0

long

runLoggingLevel (scheduler)

The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.

Enum values:

  • TRACE

  • DEBUG

  • INFO

  • WARN

  • ERROR

  • OFF

TRACE

LoggingLevel

scheduledExecutorService (scheduler)

Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.

ScheduledExecutorService

scheduler (scheduler)

To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler.

none

Object

schedulerProperties (scheduler)

To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.

Map

startScheduler (scheduler)

Whether the scheduler should be auto started.

true

boolean

timeUnit (scheduler)

Time unit for initialDelay and delay options.

Enum values:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

MILLISECONDS

TimeUnit

useFixedDelay (scheduler)

Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.

true

boolean

oauthToken (security)

The OAuth token.

String

password (security)

The password.

String

token (security)

The security token.

String

username (security)

The user name.

String

API Parameters (1 APIs)

The Zendesk endpoint is an API based component and has additional parameters based on which API name and API method is used. The API name and API method is located in the endpoint URI as the methodName path parameters:

zendesk:methodName

There are 1 API names as listed in the table below:

API Name Type Description

DEFAULT

Both

Each API is documented in the following sections to come.

API: DEFAULT

Both producer and consumer are supported

The DEFAULT API is defined in the syntax as follows:

zendesk:DEFAULT/methodName?[parameters]

The 233 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)

Method Alias Description

addTagToOrganisations

addTagToTicket

addTagToTopics

associateAttachmentsToArticle

changeUserPassword

createArticle

createArticleTranslation

createAutomation

createCategory

createCategoryTranslation

createComment

createDynamicContentItem

createDynamicContentItemVariant

createForum

createGroup

createGroupMembership

createMacro

createOrUpdateUser

createOrUpdateUsers

createOrUpdateUsersAsync

createOrganization

createOrganizationMembership

createOrganizationMemberships

createOrganizationMembershipsAsync

createOrganizations

createOrganizationsAsync

createPermissionGroup

Create permission group

createRequest

createSatisfactionRating

createSection

createSectionTranslation

createTarget

createTicket

createTicketAsync

createTicketField

createTicketForm

createTicketFromTweet

createTickets

createTicketsAsync

createTopic

createTrigger

createUpload

createUploadArticle

Create upload article with inline false

createUser

createUserIdentity

createUserSegment

Create User Segment

createUsers

createUsersAsync

deleteArticle

deleteArticleAttachment

Delete attachment from article

deleteAttachment

deleteAutomation

deleteCategory

deleteDynamicContentItem

deleteDynamicContentItemVariant

deleteForum

deleteGroup

deleteGroupMembership

deleteOrganization

deleteOrganizationMembership

deleteOrganizationMemberships

deletePermissionGroup

Delete permission group

deleteSection

deleteSuspendedTicket

deleteTarget

deleteTicket

deleteTicketField

deleteTicketForm

deleteTickets

deleteTopic

deleteTranslation

Delete translation

deleteTrigger

deleteUpload

deleteUser

deleteUserIdentity

deleteUserSegment

Delete User Segment

getArticle

getArticleFromSearch

getArticleSubscriptions

getArticleTranslations

getArticles

Get all articles from help center

getArticlesFromAllLabels

getArticlesFromAnyLabels

getArticlesFromPage

getArticlesIncrementally

getAssignableGroupMemberships

getAssignedTicketsCountForUser

getAttachment

getAttachmentsFromArticle

getAutoCompleteOrganizations

getAutomation

getCategory

getCategoryTranslations

getCcdTicketsCountForUser

getComplianceDeletionStatuses

getDeletedTickets

getDynamicContentItem

getDynamicContentItemVariant

getDynamicContentItemVariants

getForum

getForums

getGroup

getGroupMembership

getGroupMembershipByUser

getGroupMemberships

getGroupOrganization

getGroupUsers

getHolidaysForSchedule

getIncrementalTicketsResult

getJobStatus

getJobStatusAsync

getJobStatuses

getJobStatusesAsync

getMacro

getOrganization

getOrganizationMembership

getOrganizationMembershipByUser

getOrganizationMembershipForUser

getOrganizationMembershipsForOrg

getOrganizationMembershipsForUser

getOrganizationRequests

getOrganizationTickets

getOrganizationUsers

getOrganizations

getOrganizationsIncrementally

getPermissionGroup

Get permission group by id

getRequest

getRequestComment

getRequestComments

getSatisfactionRating

getSchedule

getSearchTicketResults

Ticket Search API implementation with pagination support

getSection

getSectionSubscriptions

getSectionTranslations

getSections

List Sections using a User Segment

getTarget

getTicket

getTicketAudit

getTicketAudits

getTicketCollaborators

getTicketComments

getTicketField

getTicketForm

getTicketIncidents

getTicketMetric

getTicketMetricByTicket

getTickets

getTicketsByExternalId

getTicketsCountForOrganization

getTicketsFromSearch

getTicketsIncrementally

getTopic

getTopics

List Topics using a User Segment

getTopicsByUser

getTrigger

getTriggers

getUser

getUserCCDTickets

getUserIdentities

getUserIdentity

getUserRelatedInfo

getUserRequestedTickets

getUserRequests

getUserSegment

Get user segment by id

getUserSegments

Returns the list of user segments that a particular user belongs to

getUserSubscriptions

getUsers

getUsersByExternalIds

getUsersByRole

getUsersIncrementally

getView

importTicket

importTopic

lookupOrganizationsByExternalId

lookupUserByEmail

lookupUserByExternalId

macrosShowChangesToTicket

macrosShowTicketAfterChanges

makePrivateTicketAudit

markTicketAsSpam

mergeUsers

notifyApp

permanentlyDeleteTicket

permanentlyDeleteTickets

permanentlyDeleteUser

queueCreateTicketAsync

removeTagFromOrganisations

removeTagFromTicket

removeTagFromTopics

requestVerifyUserIdentity

resetUserPassword

searchTriggers

setGroupMembershipAsDefault

setOrganizationMembershipAsDefault

setTagOnOrganisations

setTagOnTicket

setTagOnTopics

setUserPrimaryIdentity

suspendUser

trustTicketAudit

unsuspendUser

updateArticle

updateArticleTranslation

updateAutomation

updateCategory

updateCategoryTranslation

updateDynamicContentItem

updateDynamicContentItemVariant

updateForum

updateGroup

updateInstallation

updateMacro

updateOrganization

updateOrganizations

updateOrganizationsAsync

updatePermissionGroup

Update permission group

updateRequest

updateSection

updateSectionTranslation

updateTicket

updateTicketField

updateTicketForm

updateTickets

updateTicketsAsync

updateTopic

updateTrigger

updateUser

updateUserIdentity

updateUserSegment

Update User Segment

updateUsers

updateUsersAsync

verifyUserIdentity

Method addTagToOrganisations

Signatures:

  • java.util.List<String> addTagToOrganisations(long id, String[] tags);

The zendesk/addTagToOrganisations API method has the parameters listed in the table below:

Parameter Description Type

id

Long

tags

String[]

Method addTagToTicket

Signatures:

  • java.util.List<String> addTagToTicket(long id, String[] tags);

The zendesk/addTagToTicket API method has the parameters listed in the table below:

Parameter Description Type

id

Long

tags

String[]

Method addTagToTopics

Signatures:

  • java.util.List<String> addTagToTopics(long id, String[] tags);

The zendesk/addTagToTopics API method has the parameters listed in the table below:

Parameter Description Type

id

Long

tags

String[]

Method associateAttachmentsToArticle

Signatures:

  • void associateAttachmentsToArticle(String idArticle, java.util.List<org.zendesk.client.v2.model.Attachment> attachments);

The zendesk/associateAttachmentsToArticle API method has the parameters listed in the table below:

Parameter Description Type

attachments

List

idArticle

String

Method changeUserPassword

Signatures:

  • void changeUserPassword(org.zendesk.client.v2.model.User user, String oldPassword, String newPassword);

The zendesk/changeUserPassword API method has the parameters listed in the table below:

Parameter Description Type

newPassword

String

oldPassword

String

user

User

Method createArticle

Signatures:

  • org.zendesk.client.v2.model.hc.Article createArticle(org.zendesk.client.v2.model.hc.Article article);

  • org.zendesk.client.v2.model.hc.Article createArticle(org.zendesk.client.v2.model.hc.Article article, boolean notifySubscribers);

The zendesk/createArticle API method has the parameters listed in the table below:

Parameter Description Type

article

Article

notifySubscribers

Boolean

Method createArticleTranslation

Signatures:

  • org.zendesk.client.v2.model.hc.Translation createArticleTranslation(Long articleId, org.zendesk.client.v2.model.hc.Translation translation);

The zendesk/createArticleTranslation API method has the parameters listed in the table below:

Parameter Description Type

articleId

Long

translation

Translation

Method createAutomation

Signatures:

  • org.zendesk.client.v2.model.Automation createAutomation(org.zendesk.client.v2.model.Automation automation);

The zendesk/createAutomation API method has the parameters listed in the table below:

Parameter Description Type

automation

Automation

Method createCategory

Signatures:

  • org.zendesk.client.v2.model.hc.Category createCategory(org.zendesk.client.v2.model.hc.Category category);

The zendesk/createCategory API method has the parameters listed in the table below:

Parameter Description Type

category

Category

Method createCategoryTranslation

Signatures:

  • org.zendesk.client.v2.model.hc.Translation createCategoryTranslation(Long categoryId, org.zendesk.client.v2.model.hc.Translation translation);

The zendesk/createCategoryTranslation API method has the parameters listed in the table below:

Parameter Description Type

categoryId

Long

translation

Translation

Method createComment

Signatures:

  • org.zendesk.client.v2.model.Ticket createComment(long ticketId, org.zendesk.client.v2.model.Comment comment);

The zendesk/createComment API method has the parameters listed in the table below:

Parameter Description Type

comment

Comment

ticketId

Long

Method createDynamicContentItem

Signatures:

  • org.zendesk.client.v2.model.dynamic.DynamicContentItem createDynamicContentItem(org.zendesk.client.v2.model.dynamic.DynamicContentItem item);

The zendesk/createDynamicContentItem API method has the parameters listed in the table below:

Parameter Description Type

item

DynamicContentItem

Method createDynamicContentItemVariant

Signatures:

  • org.zendesk.client.v2.model.dynamic.DynamicContentItemVariant createDynamicContentItemVariant(Long itemId, org.zendesk.client.v2.model.dynamic.DynamicContentItemVariant variant);

The zendesk/createDynamicContentItemVariant API method has the parameters listed in the table below:

Parameter Description Type

itemId

Long

variant

DynamicContentItemVariant

Method createForum

Signatures:

  • org.zendesk.client.v2.model.Forum createForum(org.zendesk.client.v2.model.Forum forum);

The zendesk/createForum API method has the parameters listed in the table below:

Parameter Description Type

forum

Forum

Method createGroup

Signatures:

  • org.zendesk.client.v2.model.Group createGroup(org.zendesk.client.v2.model.Group group);

The zendesk/createGroup API method has the parameters listed in the table below:

Parameter Description Type

group

Group

Method createGroupMembership

Signatures:

  • org.zendesk.client.v2.model.GroupMembership createGroupMembership(long user_id, org.zendesk.client.v2.model.GroupMembership groupMembership);

  • org.zendesk.client.v2.model.GroupMembership createGroupMembership(org.zendesk.client.v2.model.GroupMembership groupMembership);

The zendesk/createGroupMembership API method has the parameters listed in the table below:

Parameter Description Type

groupMembership

GroupMembership

user_id

Long

Method createMacro

Signatures:

  • org.zendesk.client.v2.model.Macro createMacro(org.zendesk.client.v2.model.Macro macro);

The zendesk/createMacro API method has the parameters listed in the table below:

Parameter Description Type

macro

Macro

Method createOrUpdateUser

Signatures:

  • org.zendesk.client.v2.model.User createOrUpdateUser(org.zendesk.client.v2.model.User user);

The zendesk/createOrUpdateUser API method has the parameters listed in the table below:

Parameter Description Type

user

User

Method createOrUpdateUsers

Signatures:

  • org.zendesk.client.v2.model.JobStatus createOrUpdateUsers(java.util.List<org.zendesk.client.v2.model.User> users);

  • org.zendesk.client.v2.model.JobStatus createOrUpdateUsers(org.zendesk.client.v2.model.User[] users);

The zendesk/createOrUpdateUsers API method has the parameters listed in the table below:

Parameter Description Type

users

User[]

usersList

List

Method createOrUpdateUsersAsync

Signatures:

  • org.asynchttpclient.ListenableFuture<org.zendesk.client.v2.model.JobStatus> createOrUpdateUsersAsync(java.util.List<org.zendesk.client.v2.model.User> users);

The zendesk/createOrUpdateUsersAsync API method has the parameters listed in the table below:

Parameter Description Type

usersList

List

Method createOrganization

Signatures:

  • org.zendesk.client.v2.model.Organization createOrganization(org.zendesk.client.v2.model.Organization organization);

The zendesk/createOrganization API method has the parameters listed in the table below:

Parameter Description Type

organization

Organization

Method createOrganizationMembership

Signatures:

  • org.zendesk.client.v2.model.OrganizationMembership createOrganizationMembership(long user_id, org.zendesk.client.v2.model.OrganizationMembership organizationMembership);

  • org.zendesk.client.v2.model.OrganizationMembership createOrganizationMembership(org.zendesk.client.v2.model.OrganizationMembership organizationMembership);

The zendesk/createOrganizationMembership API method has the parameters listed in the table below:

Parameter Description Type

organizationMembership

OrganizationMembership

user_id

Long

Method createOrganizationMemberships

Signatures:

  • org.zendesk.client.v2.model.JobStatus createOrganizationMemberships(java.util.List<org.zendesk.client.v2.model.OrganizationMembership> organizationMemberships);

  • org.zendesk.client.v2.model.JobStatus createOrganizationMemberships(org.zendesk.client.v2.model.OrganizationMembership[] organizationMemberships);

The zendesk/createOrganizationMemberships API method has the parameters listed in the table below:

Parameter Description Type

organizationMembershipList

List

organizationMemberships

OrganizationMembership[]

Method createOrganizationMembershipsAsync

Signatures:

  • org.asynchttpclient.ListenableFuture<org.zendesk.client.v2.model.JobStatus> createOrganizationMembershipsAsync(java.util.List<org.zendesk.client.v2.model.OrganizationMembership> organizationMemberships);

The zendesk/createOrganizationMembershipsAsync API method has the parameters listed in the table below:

Parameter Description Type

organizationMembershipList

List

Method createOrganizations

Signatures:

  • org.zendesk.client.v2.model.JobStatus createOrganizations(java.util.List<org.zendesk.client.v2.model.Organization> organizations);

  • org.zendesk.client.v2.model.JobStatus createOrganizations(org.zendesk.client.v2.model.Organization[] organizations);

The zendesk/createOrganizations API method has the parameters listed in the table below:

Parameter Description Type

organizationList

List

organizations

Organization[]

Method createOrganizationsAsync

Signatures:

  • org.asynchttpclient.ListenableFuture<org.zendesk.client.v2.model.JobStatus> createOrganizationsAsync(java.util.List<org.zendesk.client.v2.model.Organization> organizations);

The zendesk/createOrganizationsAsync API method has the parameters listed in the table below:

Parameter Description Type

organizationList

List

Method createPermissionGroup

Signatures:

  • org.zendesk.client.v2.model.hc.PermissionGroup createPermissionGroup(org.zendesk.client.v2.model.hc.PermissionGroup permissionGroup);

The zendesk/createPermissionGroup API method has the parameters listed in the table below:

Parameter Description Type

permissionGroup

PermissionGroup

Method createRequest

Signatures:

  • org.zendesk.client.v2.model.Request createRequest(org.zendesk.client.v2.model.Request request);

The zendesk/createRequest API method has the parameters listed in the table below:

Parameter Description Type

request

Request

Method createSatisfactionRating

Signatures:

  • org.zendesk.client.v2.model.SatisfactionRating createSatisfactionRating(long ticketId, org.zendesk.client.v2.model.SatisfactionRating satisfactionRating);

  • org.zendesk.client.v2.model.SatisfactionRating createSatisfactionRating(org.zendesk.client.v2.model.Ticket ticket, org.zendesk.client.v2.model.SatisfactionRating satisfactionRating);

The zendesk/createSatisfactionRating API method has the parameters listed in the table below:

Parameter Description Type

satisfactionRating

SatisfactionRating

ticket

Ticket

ticketId

Long

Method createSection

Signatures:

  • org.zendesk.client.v2.model.hc.Section createSection(org.zendesk.client.v2.model.hc.Section section);

The zendesk/createSection API method has the parameters listed in the table below:

Parameter Description Type

section

Section

Method createSectionTranslation

Signatures:

  • org.zendesk.client.v2.model.hc.Translation createSectionTranslation(Long sectionId, org.zendesk.client.v2.model.hc.Translation translation);

The zendesk/createSectionTranslation API method has the parameters listed in the table below:

Parameter Description Type

sectionId

Long

translation

Translation

Method createTarget

Signatures:

  • org.zendesk.client.v2.model.targets.Target createTarget(org.zendesk.client.v2.model.targets.Target target);

The zendesk/createTarget API method has the parameters listed in the table below:

Parameter Description Type

target

Target

Method createTicket

Signatures:

  • org.zendesk.client.v2.model.Ticket createTicket(org.zendesk.client.v2.model.Ticket ticket);

The zendesk/createTicket API method has the parameters listed in the table below:

Parameter Description Type

ticket

Ticket

Method createTicketAsync

Signatures:

  • org.asynchttpclient.ListenableFuture<org.zendesk.client.v2.model.Ticket> createTicketAsync(org.zendesk.client.v2.model.Ticket ticket);

The zendesk/createTicketAsync API method has the parameters listed in the table below:

Parameter Description Type

ticket

Ticket

Method createTicketField

Signatures:

  • org.zendesk.client.v2.model.Field createTicketField(org.zendesk.client.v2.model.Field field);

The zendesk/createTicketField API method has the parameters listed in the table below:

Parameter Description Type

field

Field

Method createTicketForm

Signatures:

  • org.zendesk.client.v2.model.TicketForm createTicketForm(org.zendesk.client.v2.model.TicketForm ticketForm);

The zendesk/createTicketForm API method has the parameters listed in the table below:

Parameter Description Type

ticketForm

TicketForm

Method createTicketFromTweet

Signatures:

  • org.zendesk.client.v2.model.Ticket createTicketFromTweet(long tweetId, long monitorId);

The zendesk/createTicketFromTweet API method has the parameters listed in the table below:

Parameter Description Type

monitorId

Long

tweetId

Long

Method createTickets

Signatures:

  • org.zendesk.client.v2.model.JobStatus createTickets(java.util.List<org.zendesk.client.v2.model.Ticket> tickets);

  • org.zendesk.client.v2.model.JobStatus createTickets(org.zendesk.client.v2.model.Ticket[] tickets);

The zendesk/createTickets API method has the parameters listed in the table below:

Parameter Description Type

ticketList

List

tickets

Ticket[]

Method createTicketsAsync

Signatures:

  • org.asynchttpclient.ListenableFuture<org.zendesk.client.v2.model.JobStatus> createTicketsAsync(java.util.List<org.zendesk.client.v2.model.Ticket> tickets);

The zendesk/createTicketsAsync API method has the parameters listed in the table below:

Parameter Description Type

ticketList

List

Method createTopic

Signatures:

  • org.zendesk.client.v2.model.Topic createTopic(org.zendesk.client.v2.model.Topic topic);

The zendesk/createTopic API method has the parameters listed in the table below:

Parameter Description Type

topic

Topic

Method createTrigger

Signatures:

  • org.zendesk.client.v2.model.Trigger createTrigger(org.zendesk.client.v2.model.Trigger trigger);

The zendesk/createTrigger API method has the parameters listed in the table below:

Parameter Description Type

trigger

Trigger

Method createUpload

Signatures:

  • org.zendesk.client.v2.model.Attachment.Upload createUpload(String fileName, String contentType, byte[] content);

  • org.zendesk.client.v2.model.Attachment.Upload createUpload(String fileName, byte[] content);

  • org.zendesk.client.v2.model.Attachment.Upload createUpload(String token, String fileName, String contentType, byte[] content);

The zendesk/createUpload API method has the parameters listed in the table below:

Parameter Description Type

content

byte[]

contentType

String

fileName

String

token

String

Method createUploadArticle

Signatures:

  • org.zendesk.client.v2.model.hc.ArticleAttachments createUploadArticle(long articleId, java.io.File file);

  • org.zendesk.client.v2.model.hc.ArticleAttachments createUploadArticle(long articleId, java.io.File file, boolean inline);

The zendesk/createUploadArticle API method has the parameters listed in the table below:

Parameter Description Type

articleId0

Long

file

File

inline

Boolean

Method createUser

Signatures:

  • org.zendesk.client.v2.model.User createUser(org.zendesk.client.v2.model.User user);

The zendesk/createUser API method has the parameters listed in the table below:

Parameter Description Type

user

User

Method createUserIdentity

Signatures:

  • org.zendesk.client.v2.model.Identity createUserIdentity(long userId, org.zendesk.client.v2.model.Identity identity);

  • org.zendesk.client.v2.model.Identity createUserIdentity(org.zendesk.client.v2.model.User user, org.zendesk.client.v2.model.Identity identity);

The zendesk/createUserIdentity API method has the parameters listed in the table below:

Parameter Description Type

identity

Identity

user

User

userId

Long

Method createUserSegment

Signatures:

  • org.zendesk.client.v2.model.hc.UserSegment createUserSegment(org.zendesk.client.v2.model.hc.UserSegment userSegment);

The zendesk/createUserSegment API method has the parameters listed in the table below:

Parameter Description Type

userSegment

UserSegment

Method createUsers

Signatures:

  • org.zendesk.client.v2.model.JobStatus createUsers(java.util.List<org.zendesk.client.v2.model.User> users);

  • org.zendesk.client.v2.model.JobStatus createUsers(org.zendesk.client.v2.model.User[] users);

The zendesk/createUsers API method has the parameters listed in the table below:

Parameter Description Type

userList

List

users

User[]

Method createUsersAsync

Signatures:

  • org.asynchttpclient.ListenableFuture<org.zendesk.client.v2.model.JobStatus> createUsersAsync(java.util.List<org.zendesk.client.v2.model.User> users);

The zendesk/createUsersAsync API method has the parameters listed in the table below:

Parameter Description Type

userList

List

Method deleteArticle

Signatures:

  • void deleteArticle(org.zendesk.client.v2.model.hc.Article article);

The zendesk/deleteArticle API method has the parameters listed in the table below:

Parameter Description Type

article

Article

Method deleteArticleAttachment

Signatures:

  • void deleteArticleAttachment(long id);

  • void deleteArticleAttachment(org.zendesk.client.v2.model.hc.ArticleAttachments attachment);

The zendesk/deleteArticleAttachment API method has the parameters listed in the table below:

Parameter Description Type

articleAttachments

ArticleAttachments

id

Attachment identifier

Long

Method deleteAttachment

Signatures:

  • void deleteAttachment(long id);

  • void deleteAttachment(org.zendesk.client.v2.model.Attachment attachment);

The zendesk/deleteAttachment API method has the parameters listed in the table below:

Parameter Description Type

attachment

Attachment

id

Long

Method deleteAutomation

Signatures:

  • void deleteAutomation(long automationId);

The zendesk/deleteAutomation API method has the parameters listed in the table below:

Parameter Description Type

automationId0

Long

Method deleteCategory

Signatures:

  • void deleteCategory(org.zendesk.client.v2.model.hc.Category category);

The zendesk/deleteCategory API method has the parameters listed in the table below:

Parameter Description Type

category

Category

Method deleteDynamicContentItem

Signatures:

  • void deleteDynamicContentItem(org.zendesk.client.v2.model.dynamic.DynamicContentItem item);

The zendesk/deleteDynamicContentItem API method has the parameters listed in the table below:

Parameter Description Type

item

DynamicContentItem

Method deleteDynamicContentItemVariant

Signatures:

  • void deleteDynamicContentItemVariant(Long itemId, org.zendesk.client.v2.model.dynamic.DynamicContentItemVariant variant);

The zendesk/deleteDynamicContentItemVariant API method has the parameters listed in the table below:

Parameter Description Type

itemId

Long

variant

DynamicContentItemVariant

Method deleteForum

Signatures:

  • void deleteForum(org.zendesk.client.v2.model.Forum forum);

The zendesk/deleteForum API method has the parameters listed in the table below:

Parameter Description Type

forum

Forum

Method deleteGroup

Signatures:

  • void deleteGroup(long id);

  • void deleteGroup(org.zendesk.client.v2.model.Group group);

The zendesk/deleteGroup API method has the parameters listed in the table below:

Parameter Description Type

group

Group

id

Long

Method deleteGroupMembership

Signatures:

  • void deleteGroupMembership(long id);

  • void deleteGroupMembership(long user_id, long group_membership_id);

  • void deleteGroupMembership(long user_id, org.zendesk.client.v2.model.GroupMembership groupMembership);

  • void deleteGroupMembership(org.zendesk.client.v2.model.GroupMembership groupMembership);

The zendesk/deleteGroupMembership API method has the parameters listed in the table below:

Parameter Description Type

groupMembership

GroupMembership

group_membership_id

Long

id

Long

user_id

Long

Method deleteOrganization

Signatures:

  • void deleteOrganization(long id);

  • void deleteOrganization(org.zendesk.client.v2.model.Organization organization);

The zendesk/deleteOrganization API method has the parameters listed in the table below:

Parameter Description Type

id

Long

organization

Organization

Method deleteOrganizationMembership

Signatures:

  • void deleteOrganizationMembership(long id);

  • void deleteOrganizationMembership(long user_id, long organization_membership_id);

  • void deleteOrganizationMembership(long user_id, org.zendesk.client.v2.model.OrganizationMembership organizationMembership);

The zendesk/deleteOrganizationMembership API method has the parameters listed in the table below:

Parameter Description Type

id

Long

organizationMembership

OrganizationMembership

organization_membership_id

Long

user_id

Long

Method deleteOrganizationMemberships

Signatures:

  • void deleteOrganizationMemberships(long id, long[] ids);

The zendesk/deleteOrganizationMemberships API method has the parameters listed in the table below:

Parameter Description Type

id

Long

ids

long[]

Method deletePermissionGroup

Signatures:

  • void deletePermissionGroup(long id);

  • void deletePermissionGroup(org.zendesk.client.v2.model.hc.PermissionGroup permissionGroup);

The zendesk/deletePermissionGroup API method has the parameters listed in the table below:

Parameter Description Type

id

Long

permissionGroup

PermissionGroup

Method deleteSection

Signatures:

  • void deleteSection(org.zendesk.client.v2.model.hc.Section section);

The zendesk/deleteSection API method has the parameters listed in the table below:

Parameter Description Type

section

Section

Method deleteSuspendedTicket

Signatures:

  • void deleteSuspendedTicket(long id);

  • void deleteSuspendedTicket(org.zendesk.client.v2.model.SuspendedTicket ticket);

The zendesk/deleteSuspendedTicket API method has the parameters listed in the table below:

Parameter Description Type

id

Long

suspendedTicket

SuspendedTicket

Method deleteTarget

Signatures:

  • void deleteTarget(long targetId);

The zendesk/deleteTarget API method has the parameters listed in the table below:

Parameter Description Type

targetId

Long

Method deleteTicket

Signatures:

  • void deleteTicket(long id);

  • void deleteTicket(org.zendesk.client.v2.model.Ticket ticket);

The zendesk/deleteTicket API method has the parameters listed in the table below:

Parameter Description Type

id

Long

ticket

Ticket

Method deleteTicketField

Signatures:

  • void deleteTicketField(long id);

  • void deleteTicketField(org.zendesk.client.v2.model.Field field);

The zendesk/deleteTicketField API method has the parameters listed in the table below:

Parameter Description Type

field

Field

id

Long

Method deleteTicketForm

Signatures:

  • void deleteTicketForm(long id);

  • void deleteTicketForm(org.zendesk.client.v2.model.TicketForm ticketForm);

The zendesk/deleteTicketForm API method has the parameters listed in the table below:

Parameter Description Type

id

Long

ticketForm

TicketForm

Method deleteTickets

Signatures:

  • void deleteTickets(long id, long[] ids);

The zendesk/deleteTickets API method has the parameters listed in the table below:

Parameter Description Type

id

Long

ids

long[]

Method deleteTopic

Signatures:

  • void deleteTopic(org.zendesk.client.v2.model.Topic topic);

The zendesk/deleteTopic API method has the parameters listed in the table below:

Parameter Description Type

topic

Topic

Method deleteTranslation

Signatures:

  • void deleteTranslation(Long translationId);

  • void deleteTranslation(org.zendesk.client.v2.model.hc.Translation translation);

The zendesk/deleteTranslation API method has the parameters listed in the table below:

Parameter Description Type

translation

Translation

translationId

Long

Method deleteTrigger

Signatures:

  • void deleteTrigger(long triggerId);

The zendesk/deleteTrigger API method has the parameters listed in the table below:

Parameter Description Type

triggerId

Long

Method deleteUpload

Signatures:

  • void deleteUpload(String token);

  • void deleteUpload(org.zendesk.client.v2.model.Attachment.Upload upload);

The zendesk/deleteUpload API method has the parameters listed in the table below:

Parameter Description Type

token

String

upload

Upload

Method deleteUser

Signatures:

  • void deleteUser(long id);

  • void deleteUser(org.zendesk.client.v2.model.User user);

The zendesk/deleteUser API method has the parameters listed in the table below:

Parameter Description Type

id

Long

user

User

Method deleteUserIdentity

Signatures:

  • void deleteUserIdentity(long userId, long identityId);

  • void deleteUserIdentity(org.zendesk.client.v2.model.User user, long identityId);

  • void deleteUserIdentity(org.zendesk.client.v2.model.User user, org.zendesk.client.v2.model.Identity identity);

The zendesk/deleteUserIdentity API method has the parameters listed in the table below:

Parameter Description Type

identity

Identity

identityId

Long

user

User

userId

Long

Method deleteUserSegment

Signatures:

  • void deleteUserSegment(long id);

  • void deleteUserSegment(org.zendesk.client.v2.model.hc.UserSegment userSegment);

The zendesk/deleteUserSegment API method has the parameters listed in the table below:

Parameter Description Type

id

Long

userSegment

UserSegment

Method getArticle

Signatures:

  • org.zendesk.client.v2.model.hc.Article getArticle(long id);

The zendesk/getArticle API method has the parameters listed in the table below:

Parameter Description Type

id

Long

Method getArticleFromSearch

Signatures:

  • Iterable<org.zendesk.client.v2.model.hc.Article> getArticleFromSearch(String searchTerm);

  • Iterable<org.zendesk.client.v2.model.hc.Article> getArticleFromSearch(String searchTerm, Long sectionId);

The zendesk/getArticleFromSearch API method has the parameters listed in the table below:

Parameter Description Type

searchTerm

String

sectionId

Long

Method getArticleSubscriptions

Signatures:

  • Iterable<org.zendesk.client.v2.model.hc.Subscription> getArticleSubscriptions(Long articleId);

  • Iterable<org.zendesk.client.v2.model.hc.Subscription> getArticleSubscriptions(Long articleId, String locale);

The zendesk/getArticleSubscriptions API method has the parameters listed in the table below:

Parameter Description Type

articleId

Long

locale

String

Method getArticleTranslations

Signatures:

  • Iterable<org.zendesk.client.v2.model.hc.Translation> getArticleTranslations(Long articleId);

The zendesk/getArticleTranslations API method has the parameters listed in the table below:

Parameter Description Type

articleId

Long

Method getArticles

Signatures:

  • Iterable<org.zendesk.client.v2.model.hc.Article> getArticles();

  • Iterable<org.zendesk.client.v2.model.hc.Article> getArticles(String locale);

  • Iterable<org.zendesk.client.v2.model.hc.Article> getArticles(org.zendesk.client.v2.model.hc.Category category);

  • Iterable<org.zendesk.client.v2.model.hc.Article> getArticles(org.zendesk.client.v2.model.hc.Section section);

The zendesk/getArticles API method has the parameters listed in the table below:

Parameter Description Type

category

Category

locale

String

section

Section

Method getArticlesFromAllLabels

Signatures:

  • Iterable<org.zendesk.client.v2.model.hc.Article> getArticlesFromAllLabels(java.util.List<String> labels);

The zendesk/getArticlesFromAllLabels API method has the parameters listed in the table below:

Parameter Description Type

labels

List

Method getArticlesFromAnyLabels

Signatures:

  • Iterable<org.zendesk.client.v2.model.hc.Article> getArticlesFromAnyLabels(java.util.List<String> labels);

The zendesk/getArticlesFromAnyLabels API method has the parameters listed in the table below:

Parameter Description Type

labels

List

Method getArticlesFromPage

Signatures:

  • java.util.List<org.zendesk.client.v2.model.hc.Article> getArticlesFromPage(int page);

The zendesk/getArticlesFromPage API method has the parameters listed in the table below:

Parameter Description Type

page

Integer

Method getArticlesIncrementally

Signatures:

  • Iterable<org.zendesk.client.v2.model.hc.Article> getArticlesIncrementally(java.util.Date startTime);

The zendesk/getArticlesIncrementally API method has the parameters listed in the table below:

Parameter Description Type

startTime

Date

Method getAssignableGroupMemberships

Signatures:

  • Iterable<org.zendesk.client.v2.model.GroupMembership> getAssignableGroupMemberships();

  • java.util.List<org.zendesk.client.v2.model.GroupMembership> getAssignableGroupMemberships(long group_id);

The zendesk/getAssignableGroupMemberships API method has the parameters listed in the table below:

Parameter Description Type

group_id

Long

Method getAssignedTicketsCountForUser

Signatures:

  • org.zendesk.client.v2.model.TicketCount getAssignedTicketsCountForUser(long id);

The zendesk/getAssignedTicketsCountForUser API method has the parameters listed in the table below:

Parameter Description Type

id

Long

Method getAttachment

Signatures:

  • org.zendesk.client.v2.model.Attachment getAttachment(long id);

  • org.zendesk.client.v2.model.Attachment getAttachment(org.zendesk.client.v2.model.Attachment attachment);

The zendesk/getAttachment API method has the parameters listed in the table below:

Parameter Description Type

attachment

Attachment

id

Long

Method getAttachmentsFromArticle

Signatures:

  • java.util.List<org.zendesk.client.v2.model.hc.ArticleAttachments> getAttachmentsFromArticle(Long articleID);

The zendesk/getAttachmentsFromArticle API method has the parameters listed in the table below:

Parameter Description Type

articleId

Long

Method getAutoCompleteOrganizations

Signatures:

  • Iterable<org.zendesk.client.v2.model.Organization> getAutoCompleteOrganizations(String name);

The zendesk/getAutoCompleteOrganizations API method has the parameters listed in the table below:

Parameter Description Type

name

String

Method getAutomation

Signatures:

  • org.zendesk.client.v2.model.Automation getAutomation(long id);

The zendesk/getAutomation API method has the parameters listed in the table below:

Parameter Description Type

id

Long

Method getCategory

Signatures:

  • org.zendesk.client.v2.model.hc.Category getCategory(long id);

The zendesk/getCategory API method has the parameters listed in the table below:

Parameter Description Type

id

Long

Method getCategoryTranslations

Signatures:

  • Iterable<org.zendesk.client.v2.model.hc.Translation> getCategoryTranslations(Long categoryId);

The zendesk/getCategoryTranslations API method has the parameters listed in the table below:

Parameter Description Type

categoryId

Long

Method getCcdTicketsCountForUser

Signatures:

  • org.zendesk.client.v2.model.TicketCount getCcdTicketsCountForUser(long id);

The zendesk/getCcdTicketsCountForUser API method has the parameters listed in the table below:

Parameter Description Type

id

Long

Method getComplianceDeletionStatuses

Signatures:

  • Iterable<org.zendesk.client.v2.model.ComplianceDeletionStatus> getComplianceDeletionStatuses(long userId);

The zendesk/getComplianceDeletionStatuses API method has the parameters listed in the table below:

Parameter Description Type

userId

Long

Method getDeletedTickets

Signatures:

  • Iterable<org.zendesk.client.v2.model.DeletedTicket> getDeletedTickets();

  • Iterable<org.zendesk.client.v2.model.DeletedTicket> getDeletedTickets(String sortBy, org.zendesk.client.v2.model.SortOrder sortOrder);

The zendesk/getDeletedTickets API method has the parameters listed in the table below:

Parameter Description Type

sortBy

String

sortOrder

SortOrder

Method getDynamicContentItem

Signatures:

  • org.zendesk.client.v2.model.dynamic.DynamicContentItem getDynamicContentItem(long id);

The zendesk/getDynamicContentItem API method has the parameters listed in the table below:

Parameter Description Type

id

Long

Method getDynamicContentItemVariant

Signatures:

  • org.zendesk.client.v2.model.dynamic.DynamicContentItemVariant getDynamicContentItemVariant(Long itemId, long id);

The zendesk/getDynamicContentItemVariant API method has the parameters listed in the table below:

Parameter Description Type

id

Long

itemId

Long

Method getDynamicContentItemVariants

Signatures:

  • Iterable<org.zendesk.client.v2.model.dynamic.DynamicContentItemVariant> getDynamicContentItemVariants(org.zendesk.client.v2.model.dynamic.DynamicContentItem item);

The zendesk/getDynamicContentItemVariants API method has the parameters listed in the table below:

Parameter Description Type

item

DynamicContentItem

Method getForum

Signatures:

  • org.zendesk.client.v2.model.Forum getForum(long id);

The zendesk/getForum API method has the parameters listed in the table below:

Parameter Description Type

id

Long

Method getForums

Signatures:

  • Iterable<org.zendesk.client.v2.model.Forum> getForums();

  • java.util.List<org.zendesk.client.v2.model.Forum> getForums(long category_id);

The zendesk/getForums API method has the parameters listed in the table below:

Parameter Description Type

category_id

Long

Method getGroup

Signatures:

  • org.zendesk.client.v2.model.Group getGroup(long id);

The zendesk/getGroup API method has the parameters listed in the table below:

Parameter Description Type

id

Long

Method getGroupMembership

Signatures:

  • org.zendesk.client.v2.model.GroupMembership getGroupMembership(long id);

  • org.zendesk.client.v2.model.GroupMembership getGroupMembership(long user_id, long group_membership_id);

The zendesk/getGroupMembership API method has the parameters listed in the table below:

Parameter Description Type

group_membership_id

Long

id

Long

user_id

Long

Method getGroupMembershipByUser

Signatures:

  • java.util.List<org.zendesk.client.v2.model.GroupMembership> getGroupMembershipByUser(long user_id);

The zendesk/getGroupMembershipByUser API method has the parameters listed in the table below:

Parameter Description Type

user_id

Long

Method getGroupMemberships

Signatures:

  • Iterable<org.zendesk.client.v2.model.GroupMembership> getGroupMemberships();

  • java.util.List<org.zendesk.client.v2.model.GroupMembership> getGroupMemberships(long group_id);

The zendesk/getGroupMemberships API method has the parameters listed in the table below:

Parameter Description Type

group_id

Long

Method getGroupOrganization

Signatures:

  • org.zendesk.client.v2.model.OrganizationMembership getGroupOrganization(long user_id, long organization_membership_id);

The zendesk/getGroupOrganization API method has the parameters listed in the table below:

Parameter Description Type

organization_membership_id

Long

user_id

Long

Method getGroupUsers

Signatures:

  • Iterable<org.zendesk.client.v2.model.User> getGroupUsers(long id);

The zendesk/getGroupUsers API method has the parameters listed in the table below:

Parameter Description Type

id

Long

Method getHolidaysForSchedule

Signatures:

  • Iterable<org.zendesk.client.v2.model.schedules.Holiday> getHolidaysForSchedule(Long scheduleId);

  • Iterable<org.zendesk.client.v2.model.schedules.Holiday> getHolidaysForSchedule(org.zendesk.client.v2.model.schedules.Schedule schedule);

The zendesk/getHolidaysForSchedule API method has the parameters listed in the table below:

Parameter Description Type

schedule

Schedule

scheduleId

Long

Method getIncrementalTicketsResult

Signatures:

  • java.util.Map getIncrementalTicketsResult(long unixEpochTime);

The zendesk/getIncrementalTicketsResult API method has the parameters listed in the table below:

Parameter Description Type

unixEpochTime

Long

Method getJobStatus

Signatures:

  • org.zendesk.client.v2.model.JobStatus getJobStatus(org.zendesk.client.v2.model.JobStatus status);

The zendesk/getJobStatus API method has the parameters listed in the table below:

Parameter Description Type

status

JobStatus

Method getJobStatusAsync

Signatures:

  • org.asynchttpclient.ListenableFuture<org.zendesk.client.v2.model.JobStatus> getJobStatusAsync(org.zendesk.client.v2.model.JobStatus status);

The zendesk/getJobStatusAsync API method has the parameters listed in the table below:

Parameter Description Type

status

JobStatus

Method getJobStatuses

Signatures:

  • java.util.List<org.zendesk.client.v2.model.JobStatus> getJobStatuses(java.util.List<org.zendesk.client.v2.model.JobStatus> statuses);

The zendesk/getJobStatuses API method has the parameters listed in the table below:

Parameter Description Type

statuses

List

Method getJobStatusesAsync

Signatures:

  • org.asynchttpclient.ListenableFuture<java.util.List<org.zendesk.client.v2.model.JobStatus>> getJobStatusesAsync(java.util.List<org.zendesk.client.v2.model.JobStatus> statuses);

The zendesk/getJobStatusesAsync API method has the parameters listed in the table below:

Parameter Description Type

statuses

List

Method getMacro

Signatures:

  • org.zendesk.client.v2.model.Macro getMacro(long macroId);

The zendesk/getMacro API method has the parameters listed in the table below:

Parameter Description Type

macroId

Long

Method getOrganization

Signatures:

  • org.zendesk.client.v2.model.Organization getOrganization(long id);

The zendesk/getOrganization API method has the parameters listed in the table below:

Parameter Description Type

id

Long

Method getOrganizationMembership

Signatures:

  • org.zendesk.client.v2.model.OrganizationMembership getOrganizationMembership(long id);

The zendesk/getOrganizationMembership API method has the parameters listed in the table below:

Parameter Description Type

id

Long

Method getOrganizationMembershipByUser

Signatures:

  • java.util.List<org.zendesk.client.v2.model.OrganizationMembership> getOrganizationMembershipByUser(long user_id);

The zendesk/getOrganizationMembershipByUser API method has the parameters listed in the table below:

Parameter Description Type

user_id

Long

Method getOrganizationMembershipForUser

Signatures:

  • org.zendesk.client.v2.model.OrganizationMembership getOrganizationMembershipForUser(long user_id, long id);

The zendesk/getOrganizationMembershipForUser API method has the parameters listed in the table below:

Parameter Description Type

id

Long

user_id

Long

Method getOrganizationMembershipsForOrg

Signatures:

  • Iterable<org.zendesk.client.v2.model.OrganizationMembership> getOrganizationMembershipsForOrg(long organization_id);

The zendesk/getOrganizationMembershipsForOrg API method has the parameters listed in the table below:

Parameter Description Type

organization_id

Long

Method getOrganizationMembershipsForUser

Signatures:

  • Iterable<org.zendesk.client.v2.model.OrganizationMembership> getOrganizationMembershipsForUser(long user_id);

The zendesk/getOrganizationMembershipsForUser API method has the parameters listed in the table below:

Parameter Description Type

user_id

Long

Method getOrganizationRequests

Signatures:

  • Iterable<org.zendesk.client.v2.model.Request> getOrganizationRequests(long organizationId);

The zendesk/getOrganizationRequests API method has the parameters listed in the table below:

Parameter Description Type

organizationId

Long

Method getOrganizationTickets

Signatures:

  • Iterable<org.zendesk.client.v2.model.Ticket> getOrganizationTickets(long organizationId);

The zendesk/getOrganizationTickets API method has the parameters listed in the table below:

Parameter Description Type

organizationId

Long

Method getOrganizationUsers

Signatures:

  • Iterable<org.zendesk.client.v2.model.User> getOrganizationUsers(long id);

The zendesk/getOrganizationUsers API method has the parameters listed in the table below:

Parameter Description Type

id

Long

Method getOrganizations

Signatures:

  • Iterable<org.zendesk.client.v2.model.Organization> getOrganizations();

  • java.util.List<org.zendesk.client.v2.model.Organization> getOrganizations(long id, long[] ids);

The zendesk/getOrganizations API method has the parameters listed in the table below:

Parameter Description Type

id

Long

ids

long[]

Method getOrganizationsIncrementally

Signatures:

  • Iterable<org.zendesk.client.v2.model.Organization> getOrganizationsIncrementally(java.util.Date startTime);

The zendesk/getOrganizationsIncrementally API method has the parameters listed in the table below:

Parameter Description Type

startTime

Date

Method getPermissionGroup

Signatures:

  • org.zendesk.client.v2.model.hc.PermissionGroup getPermissionGroup(long id);

The zendesk/getPermissionGroup API method has the parameters listed in the table below:

Parameter Description Type

id

Long

Method getRequest

Signatures:

  • org.zendesk.client.v2.model.Request getRequest(long id);

The zendesk/getRequest API method has the parameters listed in the table below:

Parameter Description Type

id

Long

Method getRequestComment

Signatures:

  • org.zendesk.client.v2.model.Comment getRequestComment(long requestId, long commentId);

  • org.zendesk.client.v2.model.Comment getRequestComment(org.zendesk.client.v2.model.Request request, long commentId);

  • org.zendesk.client.v2.model.Comment getRequestComment(org.zendesk.client.v2.model.Request request, org.zendesk.client.v2.model.Comment comment);

The zendesk/getRequestComment API method has the parameters listed in the table below:

Parameter Description Type

comment

Comment

commentId

Long

request

Request

requestId

Long

Method getRequestComments

Signatures:

  • Iterable<org.zendesk.client.v2.model.Comment> getRequestComments(long id);

  • Iterable<org.zendesk.client.v2.model.Comment> getRequestComments(org.zendesk.client.v2.model.Request request);

The zendesk/getRequestComments API method has the parameters listed in the table below:

Parameter Description Type

id

Long

request

Request

Method getSatisfactionRating

Signatures:

  • org.zendesk.client.v2.model.SatisfactionRating getSatisfactionRating(long id);

The zendesk/getSatisfactionRating API method has the parameters listed in the table below:

Parameter Description Type

id

Long

Method getSchedule

Signatures:

  • org.zendesk.client.v2.model.schedules.Schedule getSchedule(Long scheduleId);

  • org.zendesk.client.v2.model.schedules.Schedule getSchedule(org.zendesk.client.v2.model.schedules.Schedule schedule);

The zendesk/getSchedule API method has the parameters listed in the table below:

Parameter Description Type

schedule

Schedule

scheduleId

Long

Method getSearchTicketResults

Signatures:

  • java.util.Optional<org.zendesk.client.v2.model.TicketPage> getSearchTicketResults(String query, java.util.Map<String, Object> queryParams, String sortBy, org.zendesk.client.v2.model.SortOrder sortOrder);

The zendesk/getSearchTicketResults API method has the parameters listed in the table below:

Parameter Description Type

query

String used filter a type given by searchType

String

queryParams

Additional parameters other than filter string like per_page, page etc

Map

sortBy

Name of any field of the searchType

String

sortOrder

Sort order

SortOrder

Method getSection

Signatures:

  • org.zendesk.client.v2.model.hc.Section getSection(long id);

The zendesk/getSection API method has the parameters listed in the table below:

Parameter Description Type

id

Long

Method getSectionSubscriptions

Signatures:

  • Iterable<org.zendesk.client.v2.model.hc.Subscription> getSectionSubscriptions(Long sectionId);

  • Iterable<org.zendesk.client.v2.model.hc.Subscription> getSectionSubscriptions(Long sectionId, String locale);

The zendesk/getSectionSubscriptions API method has the parameters listed in the table below:

Parameter Description Type

locale

String

sectionId

Long

Method getSectionTranslations

Signatures:

  • Iterable<org.zendesk.client.v2.model.hc.Translation> getSectionTranslations(Long sectionId);

The zendesk/getSectionTranslations API method has the parameters listed in the table below:

Parameter Description Type

sectionId

Long

Method getSections

Signatures:

  • Iterable<org.zendesk.client.v2.model.hc.Section> getSections();

  • Iterable<org.zendesk.client.v2.model.hc.Section> getSections(org.zendesk.client.v2.model.hc.Category category);

  • Iterable<org.zendesk.client.v2.model.hc.Section> getSections(org.zendesk.client.v2.model.hc.UserSegment userSegment);

The zendesk/getSections API method has the parameters listed in the table below:

Parameter Description Type

category

Category

userSegment

UserSegment

Method getTarget

Signatures:

  • org.zendesk.client.v2.model.targets.Target getTarget(long id);

The zendesk/getTarget API method has the parameters listed in the table below:

Parameter Description Type

id

Long

Method getTicket

Signatures:

  • org.zendesk.client.v2.model.Ticket getTicket(long id);

The zendesk/getTicket API method has the parameters listed in the table below:

Parameter Description Type

id

Long

Method getTicketAudit

Signatures:

  • org.zendesk.client.v2.model.Audit getTicketAudit(long ticketId, long auditId);

  • org.zendesk.client.v2.model.Audit getTicketAudit(org.zendesk.client.v2.model.Ticket ticket, long id);

  • org.zendesk.client.v2.model.Audit getTicketAudit(org.zendesk.client.v2.model.Ticket ticket, org.zendesk.client.v2.model.Audit audit);

The zendesk/getTicketAudit API method has the parameters listed in the table below:

Parameter Description Type

audit

Audit

auditId

Long

id

Long

ticket

Ticket

ticketId

Long

Method getTicketAudits

Signatures:

  • Iterable<org.zendesk.client.v2.model.Audit> getTicketAudits(Long id);

  • Iterable<org.zendesk.client.v2.model.Audit> getTicketAudits(org.zendesk.client.v2.model.Ticket ticket);

The zendesk/getTicketAudits API method has the parameters listed in the table below:

Parameter Description Type

ticket

Ticket

ticketId0

Long

Method getTicketCollaborators

Signatures:

  • java.util.List<org.zendesk.client.v2.model.User> getTicketCollaborators(long id);

The zendesk/getTicketCollaborators API method has the parameters listed in the table below:

Parameter Description Type

id

Long

Method getTicketComments

Signatures:

  • Iterable<org.zendesk.client.v2.model.Comment> getTicketComments(long id);

  • Iterable<org.zendesk.client.v2.model.Comment> getTicketComments(long id, org.zendesk.client.v2.model.SortOrder order);

The zendesk/getTicketComments API method has the parameters listed in the table below:

Parameter Description Type

id

Long

order

SortOrder

Method getTicketField

Signatures:

  • org.zendesk.client.v2.model.Field getTicketField(long id);

The zendesk/getTicketField API method has the parameters listed in the table below:

Parameter Description Type

id

Long

Method getTicketForm

Signatures:

  • org.zendesk.client.v2.model.TicketForm getTicketForm(long id);

The zendesk/getTicketForm API method has the parameters listed in the table below:

Parameter Description Type

id

Long

Method getTicketIncidents

Signatures:

  • java.util.List<org.zendesk.client.v2.model.Ticket> getTicketIncidents(long id);

The zendesk/getTicketIncidents API method has the parameters listed in the table below:

Parameter Description Type

id

Long

Method getTicketMetric

Signatures:

  • org.zendesk.client.v2.model.Metric getTicketMetric(long id);

The zendesk/getTicketMetric API method has the parameters listed in the table below:

Parameter Description Type

id

Long

Method getTicketMetricByTicket

Signatures:

  • org.zendesk.client.v2.model.Metric getTicketMetricByTicket(long id);

The zendesk/getTicketMetricByTicket API method has the parameters listed in the table below:

Parameter Description Type

id

Long

Method getTickets

Signatures:

  • Iterable<org.zendesk.client.v2.model.Ticket> getTickets();

  • java.util.List<org.zendesk.client.v2.model.Ticket> getTickets(long id, long[] ids);

The zendesk/getTickets API method has the parameters listed in the table below:

Parameter Description Type

id

Long

ids

long[]

Method getTicketsByExternalId

Signatures:

  • Iterable<org.zendesk.client.v2.model.Ticket> getTicketsByExternalId(String externalId);

  • Iterable<org.zendesk.client.v2.model.Ticket> getTicketsByExternalId(String externalId, boolean includeArchived);

The zendesk/getTicketsByExternalId API method has the parameters listed in the table below:

Parameter Description Type

externalId

String

includeArchived

Boolean

Method getTicketsCountForOrganization

Signatures:

  • org.zendesk.client.v2.model.TicketCount getTicketsCountForOrganization(long id);

The zendesk/getTicketsCountForOrganization API method has the parameters listed in the table below:

Parameter Description Type

id

Long

Method getTicketsFromSearch

Signatures:

  • Iterable<org.zendesk.client.v2.model.Ticket> getTicketsFromSearch(String searchTerm);

The zendesk/getTicketsFromSearch API method has the parameters listed in the table below:

Parameter Description Type

searchTerm

String

Method getTicketsIncrementally

Signatures:

  • Iterable<org.zendesk.client.v2.model.Ticket> getTicketsIncrementally(java.util.Date startTime);

  • Iterable<org.zendesk.client.v2.model.Ticket> getTicketsIncrementally(java.util.Date startTime, java.util.Date endTime);

The zendesk/getTicketsIncrementally API method has the parameters listed in the table below:

Parameter Description Type

endTime

Date

startTime

Date

Method getTopic

Signatures:

  • org.zendesk.client.v2.model.Topic getTopic(long id);

The zendesk/getTopic API method has the parameters listed in the table below:

Parameter Description Type

id

Long

Method getTopics

Signatures:

  • Iterable<org.zendesk.client.v2.model.Topic> getTopics();

  • Iterable<org.zendesk.client.v2.model.Topic> getTopics(org.zendesk.client.v2.model.hc.UserSegment userSegment);

  • java.util.List<org.zendesk.client.v2.model.Topic> getTopics(long forum_id);

  • java.util.List<org.zendesk.client.v2.model.Topic> getTopics(long id, long[] ids);

The zendesk/getTopics API method has the parameters listed in the table below:

Parameter Description Type

forum_id

Long

id

Long

ids

long[]

userSegment

UserSegment

Method getTopicsByUser

Signatures:

  • java.util.List<org.zendesk.client.v2.model.Topic> getTopicsByUser(long user_id);

The zendesk/getTopicsByUser API method has the parameters listed in the table below:

Parameter Description Type

user_id

Long

Method getTrigger

Signatures:

  • org.zendesk.client.v2.model.Trigger getTrigger(long id);

The zendesk/getTrigger API method has the parameters listed in the table below:

Parameter Description Type

id

Long

Method getTriggers

Signatures:

  • Iterable<org.zendesk.client.v2.model.Trigger> getTriggers();

  • Iterable<org.zendesk.client.v2.model.Trigger> getTriggers(String categoryId, boolean active, String sortBy, org.zendesk.client.v2.model.SortOrder sortOrder);

The zendesk/getTriggers API method has the parameters listed in the table below:

Parameter Description Type

active

Boolean

categoryId0

String

sortBy

String

sortOrder

SortOrder

Method getUser

Signatures:

  • org.zendesk.client.v2.model.User getUser(long id);

The zendesk/getUser API method has the parameters listed in the table below:

Parameter Description Type

id

Long

Method getUserCCDTickets

Signatures:

  • Iterable<org.zendesk.client.v2.model.Ticket> getUserCCDTickets(long userId);

The zendesk/getUserCCDTickets API method has the parameters listed in the table below:

Parameter Description Type

userId

Long

Method getUserIdentities

Signatures:

  • java.util.List<org.zendesk.client.v2.model.Identity> getUserIdentities(long userId);

  • java.util.List<org.zendesk.client.v2.model.Identity> getUserIdentities(org.zendesk.client.v2.model.User user);

The zendesk/getUserIdentities API method has the parameters listed in the table below:

Parameter Description Type

user

User

userId

Long

Method getUserIdentity

Signatures:

  • org.zendesk.client.v2.model.Identity getUserIdentity(long userId, long identityId);

  • org.zendesk.client.v2.model.Identity getUserIdentity(org.zendesk.client.v2.model.User user, long identityId);

  • org.zendesk.client.v2.model.Identity getUserIdentity(org.zendesk.client.v2.model.User user, org.zendesk.client.v2.model.Identity identity);

The zendesk/getUserIdentity API method has the parameters listed in the table below:

Parameter Description Type

identity

Identity

identityId

Long

user

User

userId

Long

Method getUserRelatedInfo

Signatures:

  • org.zendesk.client.v2.model.UserRelatedInfo getUserRelatedInfo(long userId);

The zendesk/getUserRelatedInfo API method has the parameters listed in the table below:

Parameter Description Type

userId

Long

Method getUserRequestedTickets

Signatures:

  • Iterable<org.zendesk.client.v2.model.Ticket> getUserRequestedTickets(long userId);

The zendesk/getUserRequestedTickets API method has the parameters listed in the table below:

Parameter Description Type

userId

Long

Method getUserRequests

Signatures:

  • Iterable<org.zendesk.client.v2.model.Request> getUserRequests(long id);

  • Iterable<org.zendesk.client.v2.model.Request> getUserRequests(org.zendesk.client.v2.model.User user);

The zendesk/getUserRequests API method has the parameters listed in the table below:

Parameter Description Type

id

Long

user

User

Method getUserSegment

Signatures:

  • org.zendesk.client.v2.model.hc.UserSegment getUserSegment(long id);

The zendesk/getUserSegment API method has the parameters listed in the table below:

Parameter Description Type

id

Long

Method getUserSegments

Signatures:

  • Iterable<org.zendesk.client.v2.model.hc.UserSegment> getUserSegments();

  • Iterable<org.zendesk.client.v2.model.hc.UserSegment> getUserSegments(long id);

The zendesk/getUserSegments API method has the parameters listed in the table below:

Parameter Description Type

id

Long

Method getUserSubscriptions

Signatures:

  • Iterable<org.zendesk.client.v2.model.hc.Subscription> getUserSubscriptions(Long userId);

  • Iterable<org.zendesk.client.v2.model.hc.Subscription> getUserSubscriptions(org.zendesk.client.v2.model.User user);

The zendesk/getUserSubscriptions API method has the parameters listed in the table below:

Parameter Description Type

user

User

userId0

Long

Method getUsers

Signatures:

  • Iterable<org.zendesk.client.v2.model.User> getUsers();

  • java.util.List<org.zendesk.client.v2.model.User> getUsers(long id, long[] ids);

The zendesk/getUsers API method has the parameters listed in the table below:

Parameter Description Type

id

Long

ids

long[]

Method getUsersByExternalIds

Signatures:

  • java.util.List<org.zendesk.client.v2.model.User> getUsersByExternalIds(long externalId, long[] externalIds);

The zendesk/getUsersByExternalIds API method has the parameters listed in the table below:

Parameter Description Type

externalId0

Long

externalId0s

long[]

Method getUsersByRole

Signatures:

  • Iterable<org.zendesk.client.v2.model.User> getUsersByRole(String role, String[] roles);

The zendesk/getUsersByRole API method has the parameters listed in the table below:

Parameter Description Type

role

String

roles

String[]

Method getUsersIncrementally

Signatures:

  • Iterable<org.zendesk.client.v2.model.User> getUsersIncrementally(java.util.Date startTime);

The zendesk/getUsersIncrementally API method has the parameters listed in the table below:

Parameter Description Type

startTime

Date

Method getView

Signatures:

  • Iterable<org.zendesk.client.v2.model.Ticket> getView(long id);

The zendesk/getView API method has the parameters listed in the table below:

Parameter Description Type

id

Long

Method importTicket

Signatures:

  • org.zendesk.client.v2.model.Ticket importTicket(org.zendesk.client.v2.model.TicketImport ticketImport);

The zendesk/importTicket API method has the parameters listed in the table below:

Parameter Description Type

ticketImport

TicketImport

Method importTopic

Signatures:

  • org.zendesk.client.v2.model.Topic importTopic(org.zendesk.client.v2.model.Topic topic);

The zendesk/importTopic API method has the parameters listed in the table below:

Parameter Description Type

topic

Topic

Method lookupOrganizationsByExternalId

Signatures:

  • Iterable<org.zendesk.client.v2.model.Organization> lookupOrganizationsByExternalId(String externalId);

The zendesk/lookupOrganizationsByExternalId API method has the parameters listed in the table below:

Parameter Description Type

externalId

String

Method lookupUserByEmail

Signatures:

  • Iterable<org.zendesk.client.v2.model.User> lookupUserByEmail(String email);

The zendesk/lookupUserByEmail API method has the parameters listed in the table below:

Parameter Description Type

email

String

Method lookupUserByExternalId

Signatures:

  • Iterable<org.zendesk.client.v2.model.User> lookupUserByExternalId(String externalId);

The zendesk/lookupUserByExternalId API method has the parameters listed in the table below:

Parameter Description Type

externalId

String

Method macrosShowChangesToTicket

Signatures:

  • org.zendesk.client.v2.model.Ticket macrosShowChangesToTicket(long macroId);

The zendesk/macrosShowChangesToTicket API method has the parameters listed in the table below:

Parameter Description Type

macroId

Long

Method macrosShowTicketAfterChanges

Signatures:

  • org.zendesk.client.v2.model.Ticket macrosShowTicketAfterChanges(long ticketId, long macroId);

The zendesk/macrosShowTicketAfterChanges API method has the parameters listed in the table below:

Parameter Description Type

macroId

Long

ticketId

Long

Method makePrivateTicketAudit

Signatures:

  • void makePrivateTicketAudit(long ticketId, long auditId);

  • void makePrivateTicketAudit(org.zendesk.client.v2.model.Ticket ticket, long id);

  • void makePrivateTicketAudit(org.zendesk.client.v2.model.Ticket ticket, org.zendesk.client.v2.model.Audit audit);

The zendesk/makePrivateTicketAudit API method has the parameters listed in the table below:

Parameter Description Type

audit

Audit

auditId

Long

id

Long

ticket

Ticket

ticketId

Long

Method markTicketAsSpam

Signatures:

  • void markTicketAsSpam(long id);

  • void markTicketAsSpam(org.zendesk.client.v2.model.Ticket ticket);

The zendesk/markTicketAsSpam API method has the parameters listed in the table below:

Parameter Description Type

id

Long

ticket

Ticket

Method mergeUsers

Signatures:

  • org.zendesk.client.v2.model.User mergeUsers(long userIdThatWillRemain, long userIdThatWillBeMerged);

The zendesk/mergeUsers API method has the parameters listed in the table below:

Parameter Description Type

userIdThatWillBeMerged

Long

userIdThatWillRemain

Long

Method notifyApp

Signatures:

  • void notifyApp(String json);

The zendesk/notifyApp API method has the parameters listed in the table below:

Parameter Description Type

json

String

Method permanentlyDeleteTicket

Signatures:

  • org.zendesk.client.v2.model.JobStatus permanentlyDeleteTicket(long id);

  • org.zendesk.client.v2.model.JobStatus permanentlyDeleteTicket(org.zendesk.client.v2.model.Ticket ticket);

The zendesk/permanentlyDeleteTicket API method has the parameters listed in the table below:

Parameter Description Type

id

Long

ticket

Ticket

Method permanentlyDeleteTickets

Signatures:

  • org.zendesk.client.v2.model.JobStatus permanentlyDeleteTickets(long id, long[] ids);

The zendesk/permanentlyDeleteTickets API method has the parameters listed in the table below:

Parameter Description Type

id

Long

ids

long[]

Method permanentlyDeleteUser

Signatures:

  • org.zendesk.client.v2.model.User permanentlyDeleteUser(long id);

  • org.zendesk.client.v2.model.User permanentlyDeleteUser(org.zendesk.client.v2.model.User user);

The zendesk/permanentlyDeleteUser API method has the parameters listed in the table below:

Parameter Description Type

id

Long

user

User

Method queueCreateTicketAsync

Signatures:

  • org.asynchttpclient.ListenableFuture<org.zendesk.client.v2.model.JobStatus> queueCreateTicketAsync(org.zendesk.client.v2.model.Ticket ticket);

The zendesk/queueCreateTicketAsync API method has the parameters listed in the table below:

Parameter Description Type

ticket

Ticket

Method removeTagFromOrganisations

Signatures:

  • java.util.List<String> removeTagFromOrganisations(long id, String[] tags);

The zendesk/removeTagFromOrganisations API method has the parameters listed in the table below:

Parameter Description Type

id

Long

tags

String[]

Method removeTagFromTicket

Signatures:

  • java.util.List<String> removeTagFromTicket(long id, String[] tags);

The zendesk/removeTagFromTicket API method has the parameters listed in the table below:

Parameter Description Type

id

Long

tags

String[]

Method removeTagFromTopics

Signatures:

  • java.util.List<String> removeTagFromTopics(long id, String[] tags);

The zendesk/removeTagFromTopics API method has the parameters listed in the table below:

Parameter Description Type

id

Long

tags

String[]

Method requestVerifyUserIdentity

Signatures:

  • org.zendesk.client.v2.model.Identity requestVerifyUserIdentity(long userId, long identityId);

  • org.zendesk.client.v2.model.Identity requestVerifyUserIdentity(org.zendesk.client.v2.model.User user, long identityId);

  • org.zendesk.client.v2.model.Identity requestVerifyUserIdentity(org.zendesk.client.v2.model.User user, org.zendesk.client.v2.model.Identity identity);

The zendesk/requestVerifyUserIdentity API method has the parameters listed in the table below:

Parameter Description Type

identity

Identity

identityId

Long

user

User

userId

Long

Method resetUserPassword

Signatures:

  • void resetUserPassword(long id, String password);

  • void resetUserPassword(org.zendesk.client.v2.model.User user, String password);

The zendesk/resetUserPassword API method has the parameters listed in the table below:

Parameter Description Type

id

Long

password

String

user

User

Method searchTriggers

Signatures:

  • Iterable<org.zendesk.client.v2.model.Trigger> searchTriggers(String query);

  • Iterable<org.zendesk.client.v2.model.Trigger> searchTriggers(String query, boolean active, String sortBy, org.zendesk.client.v2.model.SortOrder sortOrder);

The zendesk/searchTriggers API method has the parameters listed in the table below:

Parameter Description Type

active

Boolean

query

String

sortBy

String

sortOrder

SortOrder

Method setGroupMembershipAsDefault

Signatures:

  • java.util.List<org.zendesk.client.v2.model.GroupMembership> setGroupMembershipAsDefault(long user_id, org.zendesk.client.v2.model.GroupMembership groupMembership);

The zendesk/setGroupMembershipAsDefault API method has the parameters listed in the table below:

Parameter Description Type

groupMembership

GroupMembership

user_id

Long

Method setOrganizationMembershipAsDefault

Signatures:

  • java.util.List<org.zendesk.client.v2.model.OrganizationMembership> setOrganizationMembershipAsDefault(long user_id, org.zendesk.client.v2.model.OrganizationMembership organizationMembership);

The zendesk/setOrganizationMembershipAsDefault API method has the parameters listed in the table below:

Parameter Description Type

organizationMembership

OrganizationMembership

user_id

Long

Method setTagOnOrganisations

Signatures:

  • java.util.List<String> setTagOnOrganisations(long id, String[] tags);

The zendesk/setTagOnOrganisations API method has the parameters listed in the table below:

Parameter Description Type

id

Long

tags

String[]

Method setTagOnTicket

Signatures:

  • java.util.List<String> setTagOnTicket(long id, String[] tags);

The zendesk/setTagOnTicket API method has the parameters listed in the table below:

Parameter Description Type

id

Long

tags

String[]

Method setTagOnTopics

Signatures:

  • java.util.List<String> setTagOnTopics(long id, String[] tags);

The zendesk/setTagOnTopics API method has the parameters listed in the table below:

Parameter Description Type

id

Long

tags

String[]

Method setUserPrimaryIdentity

Signatures:

  • java.util.List<org.zendesk.client.v2.model.Identity> setUserPrimaryIdentity(long userId, long identityId);

  • java.util.List<org.zendesk.client.v2.model.Identity> setUserPrimaryIdentity(org.zendesk.client.v2.model.User user, long identityId);

  • java.util.List<org.zendesk.client.v2.model.Identity> setUserPrimaryIdentity(org.zendesk.client.v2.model.User user, org.zendesk.client.v2.model.Identity identity);

The zendesk/setUserPrimaryIdentity API method has the parameters listed in the table below:

Parameter Description Type

identity

Identity

identityId

Long

user

User

userId

Long

Method suspendUser

Signatures:

  • org.zendesk.client.v2.model.User suspendUser(long id);

The zendesk/suspendUser API method has the parameters listed in the table below:

Parameter Description Type

id

Long

Method trustTicketAudit

Signatures:

  • void trustTicketAudit(long ticketId, long auditId);

  • void trustTicketAudit(org.zendesk.client.v2.model.Ticket ticket, long id);

  • void trustTicketAudit(org.zendesk.client.v2.model.Ticket ticket, org.zendesk.client.v2.model.Audit audit);

The zendesk/trustTicketAudit API method has the parameters listed in the table below:

Parameter Description Type

audit

Audit

auditId

Long

id

Long

ticket

Ticket

ticketId

Long

Method unsuspendUser

Signatures:

  • org.zendesk.client.v2.model.User unsuspendUser(long id);

The zendesk/unsuspendUser API method has the parameters listed in the table below:

Parameter Description Type

id

Long

Method updateArticle

Signatures:

  • org.zendesk.client.v2.model.hc.Article updateArticle(org.zendesk.client.v2.model.hc.Article article);

The zendesk/updateArticle API method has the parameters listed in the table below:

Parameter Description Type

article

Article

Method updateArticleTranslation

Signatures:

  • org.zendesk.client.v2.model.hc.Translation updateArticleTranslation(Long articleId, String locale, org.zendesk.client.v2.model.hc.Translation translation);

The zendesk/updateArticleTranslation API method has the parameters listed in the table below:

Parameter Description Type

articleId

Long

locale

String

translation

Translation

Method updateAutomation

Signatures:

  • org.zendesk.client.v2.model.Automation updateAutomation(Long automationId, org.zendesk.client.v2.model.Automation automation);

The zendesk/updateAutomation API method has the parameters listed in the table below:

Parameter Description Type

automation

Automation

automationId

Long

Method updateCategory

Signatures:

  • org.zendesk.client.v2.model.hc.Category updateCategory(org.zendesk.client.v2.model.hc.Category category);

The zendesk/updateCategory API method has the parameters listed in the table below:

Parameter Description Type

category

Category

Method updateCategoryTranslation

Signatures:

  • org.zendesk.client.v2.model.hc.Translation updateCategoryTranslation(Long categoryId, String locale, org.zendesk.client.v2.model.hc.Translation translation);

The zendesk/updateCategoryTranslation API method has the parameters listed in the table below:

Parameter Description Type

categoryId

Long

locale

String

translation

Translation

Method updateDynamicContentItem

Signatures:

  • org.zendesk.client.v2.model.dynamic.DynamicContentItem updateDynamicContentItem(org.zendesk.client.v2.model.dynamic.DynamicContentItem item);

The zendesk/updateDynamicContentItem API method has the parameters listed in the table below:

Parameter Description Type

item

DynamicContentItem

Method updateDynamicContentItemVariant

Signatures:

  • org.zendesk.client.v2.model.dynamic.DynamicContentItemVariant updateDynamicContentItemVariant(Long itemId, org.zendesk.client.v2.model.dynamic.DynamicContentItemVariant variant);

The zendesk/updateDynamicContentItemVariant API method has the parameters listed in the table below:

Parameter Description Type

itemId

Long

variant

DynamicContentItemVariant

Method updateForum

Signatures:

  • org.zendesk.client.v2.model.Forum updateForum(org.zendesk.client.v2.model.Forum forum);

The zendesk/updateForum API method has the parameters listed in the table below:

Parameter Description Type

forum

Forum

Method updateGroup

Signatures:

  • org.zendesk.client.v2.model.Group updateGroup(org.zendesk.client.v2.model.Group group);

The zendesk/updateGroup API method has the parameters listed in the table below:

Parameter Description Type

group

Group

Method updateInstallation

Signatures:

  • void updateInstallation(int id, String json);

The zendesk/updateInstallation API method has the parameters listed in the table below:

Parameter Description Type

installationId

Integer

json

String

Method updateMacro

Signatures:

  • org.zendesk.client.v2.model.Macro updateMacro(Long macroId, org.zendesk.client.v2.model.Macro macro);

The zendesk/updateMacro API method has the parameters listed in the table below:

Parameter Description Type

macro

Macro

macroId0

Long

Method updateOrganization

Signatures:

  • org.zendesk.client.v2.model.Organization updateOrganization(org.zendesk.client.v2.model.Organization organization);

The zendesk/updateOrganization API method has the parameters listed in the table below:

Parameter Description Type

organization

Organization

Method updateOrganizations

Signatures:

  • org.zendesk.client.v2.model.JobStatus updateOrganizations(java.util.List<org.zendesk.client.v2.model.Organization> organizations);

  • org.zendesk.client.v2.model.JobStatus updateOrganizations(org.zendesk.client.v2.model.Organization[] organizations);

The zendesk/updateOrganizations API method has the parameters listed in the table below:

Parameter Description Type

organizationList

List

organizations

Organization[]

Method updateOrganizationsAsync

Signatures:

  • org.asynchttpclient.ListenableFuture<org.zendesk.client.v2.model.JobStatus> updateOrganizationsAsync(java.util.List<org.zendesk.client.v2.model.Organization> organizations);

The zendesk/updateOrganizationsAsync API method has the parameters listed in the table below:

Parameter Description Type

organizationList

List

Method updatePermissionGroup

Signatures:

  • org.zendesk.client.v2.model.hc.PermissionGroup updatePermissionGroup(org.zendesk.client.v2.model.hc.PermissionGroup permissionGroup);

The zendesk/updatePermissionGroup API method has the parameters listed in the table below:

Parameter Description Type

permissionGroup

PermissionGroup

Method updateRequest

Signatures:

  • org.zendesk.client.v2.model.Request updateRequest(org.zendesk.client.v2.model.Request request);

The zendesk/updateRequest API method has the parameters listed in the table below:

Parameter Description Type

request

Request

Method updateSection

Signatures:

  • org.zendesk.client.v2.model.hc.Section updateSection(org.zendesk.client.v2.model.hc.Section section);

The zendesk/updateSection API method has the parameters listed in the table below:

Parameter Description Type

section

Section

Method updateSectionTranslation

Signatures:

  • org.zendesk.client.v2.model.hc.Translation updateSectionTranslation(Long sectionId, String locale, org.zendesk.client.v2.model.hc.Translation translation);

The zendesk/updateSectionTranslation API method has the parameters listed in the table below:

Parameter Description Type

locale

String

sectionId

Long

translation

Translation

Method updateTicket

Signatures:

  • org.zendesk.client.v2.model.Ticket updateTicket(org.zendesk.client.v2.model.Ticket ticket);

The zendesk/updateTicket API method has the parameters listed in the table below:

Parameter Description Type

ticket

Ticket

Method updateTicketField

Signatures:

  • org.zendesk.client.v2.model.Field updateTicketField(org.zendesk.client.v2.model.Field field);

The zendesk/updateTicketField API method has the parameters listed in the table below:

Parameter Description Type

field

Field

Method updateTicketForm

Signatures:

  • org.zendesk.client.v2.model.TicketForm updateTicketForm(org.zendesk.client.v2.model.TicketForm ticketForm);

The zendesk/updateTicketForm API method has the parameters listed in the table below:

Parameter Description Type

ticketForm

TicketForm

Method updateTickets

Signatures:

  • org.zendesk.client.v2.model.JobStatus updateTickets(java.util.List<org.zendesk.client.v2.model.Ticket> tickets);

  • org.zendesk.client.v2.model.JobStatus updateTickets(org.zendesk.client.v2.model.Ticket[] tickets);

The zendesk/updateTickets API method has the parameters listed in the table below:

Parameter Description Type

ticketList

List

tickets

Ticket[]

Method updateTicketsAsync

Signatures:

  • org.asynchttpclient.ListenableFuture<org.zendesk.client.v2.model.JobStatus> updateTicketsAsync(java.util.List<org.zendesk.client.v2.model.Ticket> tickets);

The zendesk/updateTicketsAsync API method has the parameters listed in the table below:

Parameter Description Type

ticketList

List

Method updateTopic

Signatures:

  • org.zendesk.client.v2.model.Topic updateTopic(org.zendesk.client.v2.model.Topic topic);

The zendesk/updateTopic API method has the parameters listed in the table below:

Parameter Description Type

topic

Topic

Method updateTrigger

Signatures:

  • org.zendesk.client.v2.model.Trigger updateTrigger(Long triggerId, org.zendesk.client.v2.model.Trigger trigger);

The zendesk/updateTrigger API method has the parameters listed in the table below:

Parameter Description Type

trigger

Trigger

triggerId0

Long

Method updateUser

Signatures:

  • org.zendesk.client.v2.model.User updateUser(org.zendesk.client.v2.model.User user);

The zendesk/updateUser API method has the parameters listed in the table below:

Parameter Description Type

user

User

Method updateUserIdentity

Signatures:

  • org.zendesk.client.v2.model.Identity updateUserIdentity(long userId, org.zendesk.client.v2.model.Identity identity);

  • org.zendesk.client.v2.model.Identity updateUserIdentity(org.zendesk.client.v2.model.User user, org.zendesk.client.v2.model.Identity identity);

The zendesk/updateUserIdentity API method has the parameters listed in the table below:

Parameter Description Type

identity

Identity

user

User

userId

Long

Method updateUserSegment

Signatures:

  • org.zendesk.client.v2.model.hc.UserSegment updateUserSegment(org.zendesk.client.v2.model.hc.UserSegment userSegment);

The zendesk/updateUserSegment API method has the parameters listed in the table below:

Parameter Description Type

userSegment

UserSegment

Method updateUsers

Signatures:

  • org.zendesk.client.v2.model.JobStatus updateUsers(java.util.List<org.zendesk.client.v2.model.User> users);

  • org.zendesk.client.v2.model.JobStatus updateUsers(org.zendesk.client.v2.model.User[] users);

The zendesk/updateUsers API method has the parameters listed in the table below:

Parameter Description Type

users

User[]

usersList

List

Method updateUsersAsync

Signatures:

  • org.asynchttpclient.ListenableFuture<org.zendesk.client.v2.model.JobStatus> updateUsersAsync(java.util.List<org.zendesk.client.v2.model.User> users);

The zendesk/updateUsersAsync API method has the parameters listed in the table below:

Parameter Description Type

usersList

List

Method verifyUserIdentity

Signatures:

  • org.zendesk.client.v2.model.Identity verifyUserIdentity(long userId, long identityId);

  • org.zendesk.client.v2.model.Identity verifyUserIdentity(org.zendesk.client.v2.model.User user, long identityId);

  • org.zendesk.client.v2.model.Identity verifyUserIdentity(org.zendesk.client.v2.model.User user, org.zendesk.client.v2.model.Identity identity);

The zendesk/verifyUserIdentity API method has the parameters listed in the table below:

Parameter Description Type

identity

Identity

identityId

Long

user

User

userId

Long

In addition to the parameters above, the zendesk API can also use any of the Query Parameters (26 parameters).

Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. The message header name must be of the format CamelZendesk.parameter. The inBody parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere would override a CamelZendesk.myParameterNameHere header.

Spring Boot Auto-Configuration

When using zendesk with Spring Boot make sure to use the following Maven dependency to have support for auto configuration:

<dependency>
  <groupId>org.apache.camel.springboot</groupId>
  <artifactId>camel-zendesk-starter</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel core version -->
</dependency>

The component supports 11 options, which are listed below.

Name Description Default Type

camel.component.zendesk.autowired-enabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

Boolean

camel.component.zendesk.bridge-error-handler

Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored.

false

Boolean

camel.component.zendesk.configuration

Component configuration. The option is a org.apache.camel.component.zendesk.ZendeskConfiguration type.

ZendeskConfiguration

camel.component.zendesk.enabled

Whether to enable auto configuration of the zendesk component. This is enabled by default.

Boolean

camel.component.zendesk.lazy-start-producer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

Boolean

camel.component.zendesk.oauth-token

The OAuth token.

String

camel.component.zendesk.password

The password.

String

camel.component.zendesk.server-url

The server URL to connect.

String

camel.component.zendesk.token

The security token.

String

camel.component.zendesk.username

The user name.

String

camel.component.zendesk.zendesk

To use a shared Zendesk instance. The option is a org.zendesk.client.v2.Zendesk type.

Zendesk
Back to top