Module zendesk

ballerinax/zendesk Ballerina library

2.0.0

Overview

Zendesk is a customer service software company that provides a cloud-based customer support platform. It is designed to offer a seamless and efficient customer service experience, enabling businesses to manage customer interactions across multiple channels, including email, chat, phone, and social media.

The Ballerina Zendesk Connector allows developers to interact with the Zendesk REST API V2, making it easier to integrate customer support features into Ballerina applications. This connector enables the automation of Zendesk Support operations such as ticket management, user and organization management, and more.

Setup guide

To use the Zendesk Connector in Ballerina, you must have a Zendesk account and an API token for authentication. Follow the steps below to set up the connector with your Zendesk account. If you don't have an account, you can create one by visiting Zendesk Sign Up page and completing the registration process.

Step 1: Log in to Zendesk

Sign in to your Zendesk account.
Navigate to the dashboard.

Step 2: Access admin center

Click on the Settings icon in the sidebar.
Click on Go to Admin Center.

Step 3: Create a new connection

In the Admin Center, click on Apps and integrations.
Click on Connections under the Connections section.
Click on Create connection to create a new connection.

Step 4: Configure connection settings

When creating a new connection, you will be prompted to provide the following details:

Connection name: A descriptive name for the connection.
Authentication type: Possible options are API key, Basic Auth, Bearer Token, and OAuth 2.0.
Allowed domain: The domain that the connection is allowed to access. You can use a wildcard to allow requests made to any subdomain by adding an asterisk (*) at the start.

Note: The rest of the fields (e.g. username, password, token) will appear based on the selected authentication type.

Quickstart

To begin using the Zendesk connector in your Ballerina application, you'll need to follow these steps:

Step 1: Import the connector

First, import the ballerinax/zendesk package into your Ballerina project.


import ballerinax/zendesk;

Step 2: Instantiate a new connector

Create a zendesk:ConnectionConfig object with your domain and API token, and initialize the connector.


zendesk:ConnectionConfig zendeskConfig = {
    auth: {
        username: "<username>",
        password: "<password>"
    }
};

zendesk:Client zendesk = check new (zendeskConfig, "https://<your-domain>.zendesk.com");

Step 3: Invoke the connector operation

Utilize the connector's operations to manage tickets, users, organizations, etc.

Create a ticket


zendesk:TicketCreateRequest ticket = {
    ticket: {
        subject: "Subject of the ticket",
        comment: {
            body: "Body of the ticket comment"
        }
    }
};

zendesk:TicketResponse createResponse = check zendesk->/api/v2/tickets.post(ticket);

List tickets


zendesk:TicketsResponse tickets = check zendesk->/api/v2/tickets;

Examples

The Zendesk connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering the following use cases:

Multi channel support integration - Integrate Zendesk with multiple customer support channels to streamline ticket management.
Customer satisfaction survey analysis - Analyze customer satisfaction survey responses to improve support services.

Clients

zendesk: Client

Isolated

Zendesk Support API endpoints

Constructor

Gets invoked to initialize the connector.

init (ConnectionConfig config, string serviceUrl)

config ConnectionConfig - The configurations to be used when initializing the connector

serviceUrl string - URL of the target service

get api/lotus/assignables/autocomplete.json

Isolated FunctionResource Function

function get api/lotus/assignables/autocomplete\.json(string name, string accept) returns AssigneeFieldAssignableGroupsAndAgentsSearchResponse|error

List assignable groups and agents based on query matched against name

Parameters

name string - Query string used to search assignable groups & agents in the AssigneeField

accept string (default "application/json") -

Return Type

AssigneeFieldAssignableGroupsAndAgentsSearchResponse|error - Success response

get api/lotus/assignables/groups.json

Isolated FunctionResource Function

function get api/lotus/assignables/groups\.json() returns AssigneeFieldAssignableGroupsResponse|error

List assignable groups on the AssigneeField

Return Type

AssigneeFieldAssignableGroupsResponse|error - Success response

get api/lotus/assignables/groups/[int group_id]/agents.json

Isolated FunctionResource Function

function get api/lotus/assignables/groups/[int group_id]/agents\.json(string accept) returns AssigneeFieldAssignableGroupAgentsResponse|error

List assignable agents from a group on the AssigneeField

Parameters

accept string (default "application/json") -

Return Type

AssigneeFieldAssignableGroupAgentsResponse|error - Success response

get api/v2/[string target_type]/[int target_id]/relationship_fields/[int field_id]/[string source_type]

Isolated FunctionResource Function

function get api/v2/[string target_type]/[int target_id]/relationship_fields/[int field_id]/[string source_type](string accept) returns ReverseLookupResponse|error

Get sources by target

Parameters

accept string (default "application/json") -

Return Type

ReverseLookupResponse|error - Success response

get api/v2/account/settings

Isolated FunctionResource Function

function get api/v2/account/settings() returns AccountSettingsResponse|error

Show Settings

Return Type

AccountSettingsResponse|error - Success response

put api/v2/account/settings

Isolated FunctionResource Function

function put api/v2/account/settings() returns AccountSettingsResponse|error

Update Account Settings

Return Type

AccountSettingsResponse|error - Success response

post api/v2/accounts

Isolated FunctionResource Function

function post api/v2/accounts() returns TrialAccountResponse|error

Create Trial Account

Return Type

TrialAccountResponse|error - Created response

get api/v2/accounts/available

Isolated FunctionResource Function

function get api/v2/accounts/available(string subdomain, string accept) returns Inline_response_200|error

Verify Subdomain Availability

Parameters

subdomain string - Specify the name of the subdomain you want to verify. The name can't contain underscores, hyphens, or spaces.

accept string (default "application/json") -

Return Type

Inline_response_200|error - Success response

get api/v2/activities

Isolated FunctionResource Function

function get api/v2/activities(string accept, string? since) returns ActivitiesResponse|error

List Activities

Parameters

accept string (default "application/json") -

since string? (default ()) - A UTC time in ISO 8601 format to return ticket activities since said date.

Return Type

ActivitiesResponse|error - Success response

get api/v2/activities/[int activity_id]

Isolated FunctionResource Function

function get api/v2/activities/[int activity_id](string accept) returns ActivityResponse|error

Show Activity

Parameters

accept string (default "application/json") -

Return Type

ActivityResponse|error - Success response

get api/v2/activities/count

Isolated FunctionResource Function

function get api/v2/activities/count() returns ActivitiesCountResponse|error

Count Activities

Return Type

ActivitiesCountResponse|error - Count of ticket activities

post api/v2/any_channel/channelback/report_error

Isolated FunctionResource Function

function post api/v2/any_channel/channelback/report_error() returns string|error

Report Channelback Error to Zendesk

Return Type

string|error - Success response

post api/v2/any_channel/push

Isolated FunctionResource Function

function post api/v2/any_channel/push() returns ChannelFrameworkPushResultsResponse|error

Push Content to Support

Return Type

ChannelFrameworkPushResultsResponse|error - Success response

post api/v2/any_channel/validate_token

Isolated FunctionResource Function

function post api/v2/any_channel/validate_token() returns string|error

Validate Token

Return Type

string|error - Success response

get api/v2/attachments/[int attachment_id]

Isolated FunctionResource Function

function get api/v2/attachments/[int attachment_id](string accept) returns AttachmentResponse|error

Show Attachment

Parameters

accept string (default "application/json") -

Return Type

AttachmentResponse|error - Success Response

put api/v2/attachments/[int attachment_id]

Isolated FunctionResource Function

function put api/v2/attachments/[int attachment_id](AttachmentUpdateRequest payload, string accept) returns AttachmentResponse|error

Update Attachment for Malware

Parameters

payload AttachmentUpdateRequest -

accept string (default "application/json") -

Return Type

AttachmentResponse|error - Success response

get api/v2/audit_logs

Isolated FunctionResource Function

function get api/v2/audit_logs(string accept, string? filterSource_type, int? filterSource_id, int? filterActor_id, string? filterIp_address, string? filterCreated_at, string? filterAction, string? sort_by, string? sort_order, string? sort) returns AuditLogsResponse|error

List Audit Logs

Parameters

accept string (default "application/json") -

filterSource_type string? (default ()) - Filter audit logs by the source type. For example, user or rule

filterSource_id int? (default ()) - Filter audit logs by the source id. Requires filter[source_type] to also be set

filterActor_id int? (default ()) - Filter audit logs by the actor id

filterIp_address string? (default ()) - Filter audit logs by the ip address

filterCreated_at string? (default ()) - Filter audit logs by the time of creation. When used, you must specify filter[created_at] twice in your request, first with the start time and again with an end time

filterAction string? (default ()) - Filter audit logs by the action

sort_by string? (default ()) - Offset pagination only. Sort audit logs. Default is sort_by=created_at

sort_order string? (default ()) - Offset pagination only. Sort audit logs. Default is sort_order=desc

sort string? (default ()) - Cursor pagination only. Sort audit logs. Default is sort=-created_at

Return Type

AuditLogsResponse|error - Success response

get api/v2/audit_logs/[int audit_log_id]

Isolated FunctionResource Function

function get api/v2/audit_logs/[int audit_log_id](string accept) returns AuditLogResponse|error

Show Audit Log

Parameters

accept string (default "application/json") -

Return Type

AuditLogResponse|error - Success response

post api/v2/audit_logs/export

Isolated FunctionResource Function

function post api/v2/audit_logs/export(string accept, string? filterSource_type, int? filterSource_id, int? filterActor_id, string? filterIp_address, string? filterCreated_at, string? filterAction) returns string|error

Export Audit Logs

Parameters

accept string (default "application/json") -

filterSource_type string? (default ()) - Filter audit logs by the source type. For example, user or rule

filterSource_id int? (default ()) - Filter audit logs by the source id. Requires filter[source_type] to also be set.

filterActor_id int? (default ()) - Filter audit logs by the actor id

filterIp_address string? (default ()) - Filter audit logs by the ip address

filterCreated_at string? (default ()) - Filter audit logs by the time of creation. When used, you must specify filter[created_at] twice in your request, first with the start time and again with an end time

filterAction string? (default ()) - Filter audit logs by the action

Return Type

string|error - Accepted description

get api/v2/autocomplete/tags

Isolated FunctionResource Function

function get api/v2/autocomplete/tags(string accept, string? name) returns TagsByObjectIdResponse|error

Search Tags

Parameters

accept string (default "application/json") -

name string? (default ()) - A substring of a tag to search for

Return Type

TagsByObjectIdResponse|error - Success response

get api/v2/automations

Isolated FunctionResource Function

function get api/v2/automations() returns AutomationsResponse|error

List Automations

Return Type

AutomationsResponse|error - Success response

post api/v2/automations

Isolated FunctionResource Function

function post api/v2/automations() returns AutomationResponse|error

Create Automation

Return Type

AutomationResponse|error - Created response

get api/v2/automations/[int automation_id]

Isolated FunctionResource Function

function get api/v2/automations/[int automation_id](string accept) returns AutomationResponse|error

Show Automation

Parameters

accept string (default "application/json") -

Return Type

AutomationResponse|error - Success response

put api/v2/automations/[int automation_id]

Isolated FunctionResource Function

function put api/v2/automations/[int automation_id](string accept) returns AutomationResponse|error

Update Automation

Parameters

accept string (default "application/json") -

Return Type

AutomationResponse|error - Success response

delete api/v2/automations/[int automation_id]

Isolated FunctionResource Function

function delete api/v2/automations/[int automation_id](string accept) returns error?

Delete Automation

Parameters

accept string (default "application/json") -

Return Type

error? - No Content response

get api/v2/automations/active

Isolated FunctionResource Function

function get api/v2/automations/active() returns AutomationsResponse|error

List Active Automations

Return Type

AutomationsResponse|error - Success response

delete api/v2/automations/destroy_many

Isolated FunctionResource Function

function delete api/v2/automations/destroy_many(string accept, int[]? ids) returns error?

Bulk Delete Automations

Parameters

accept string (default "application/json") -

ids int[]? (default ()) - The IDs of the automations to delete

Return Type

error? - No Content response

get api/v2/automations/search

Isolated FunctionResource Function

function get api/v2/automations/search(string query, string accept, boolean? active, string? sort_by, string? sort_order, string? include) returns AutomationsResponse|error

Search Automations

Parameters

query string - Query string used to find all automations with matching title

accept string (default "application/json") -

active boolean? (default ()) - Filter by active automations if true or inactive automations if false

sort_by string? (default ()) - Possible values are "alphabetical", "created_at", "updated_at", and "position". If unspecified, the automations are sorted by relevance

sort_order string? (default ()) - One of "asc" or "desc". Defaults to "asc" for alphabetical and position sort, "desc" for all others

include string? (default ()) - A sideload to include in the response. See Sideloads

Return Type

AutomationsResponse|error - Success response

put api/v2/automations/update_many

Isolated FunctionResource Function

function put api/v2/automations/update_many() returns AutomationsResponse|error

Update Many Automations

Return Type

AutomationsResponse|error - Success response

get api/v2/bookmarks

Isolated FunctionResource Function

function get api/v2/bookmarks() returns BookmarksResponse|error

List Bookmarks

Return Type

BookmarksResponse|error - Successful response

post api/v2/bookmarks

Isolated FunctionResource Function

function post api/v2/bookmarks(BookmarkCreateRequest payload) returns BookmarkResponse|error

Create Bookmark

Parameters

payload BookmarkCreateRequest -

Return Type

BookmarkResponse|error - Successfully created

delete api/v2/bookmarks/[int bookmark_id]

Isolated FunctionResource Function

function delete api/v2/bookmarks/[int bookmark_id](string accept) returns error?

Delete Bookmark

Parameters

accept string (default "application/json") -

Return Type

error? - No content

get api/v2/brands

Isolated FunctionResource Function

function get api/v2/brands() returns BrandsResponse|error

List Brands

Return Type

BrandsResponse|error - Successful response

post api/v2/brands

Isolated FunctionResource Function

function post api/v2/brands(BrandCreateRequest payload) returns BrandResponse|error

Create Brand

Parameters

payload BrandCreateRequest -

Return Type

BrandResponse|error - Successful response

get api/v2/brands/[int brand_id]

Isolated FunctionResource Function

function get api/v2/brands/[int brand_id](string accept) returns BrandResponse|error

Show a Brand

Parameters

accept string (default "application/json") -

Return Type

BrandResponse|error - Successful response

put api/v2/brands/[int brand_id]

Isolated FunctionResource Function

function put api/v2/brands/[int brand_id](BrandUpdateRequest payload, string accept) returns BrandResponse|error

Update a Brand

Parameters

payload BrandUpdateRequest -

accept string (default "application/json") -

Return Type

BrandResponse|error - Successful response

delete api/v2/brands/[int brand_id]

Isolated FunctionResource Function

function delete api/v2/brands/[int brand_id](string accept) returns error?

Delete a Brand

Parameters

accept string (default "application/json") -

Return Type

error? - No Content response

get api/v2/brands/[int brand_id]/check_host_mapping

Isolated FunctionResource Function

function get api/v2/brands/[int brand_id]/check_host_mapping(string accept) returns HostMappingObject|error

Check Host Mapping Validity for an Existing Brand

Parameters

accept string (default "application/json") -

Return Type

HostMappingObject|error - Successful response

get api/v2/brands/check_host_mapping

Isolated FunctionResource Function

function get api/v2/brands/check_host_mapping(string host_mapping, string subdomain, string accept) returns HostMappingObject|error

Check Host Mapping Validity

Parameters

host_mapping string - The hostmapping to a brand, if any (only admins view this key)

subdomain string - Subdomain for a given Zendesk account address

accept string (default "application/json") -

Return Type

HostMappingObject|error - Successful response

get api/v2/channels/twitter/monitored_twitter_handles

Isolated FunctionResource Function

function get api/v2/channels/twitter/monitored_twitter_handles() returns TwitterChannelsResponse|error

List Monitored Twitter Handles

Return Type

TwitterChannelsResponse|error - Success response

get api/v2/channels/twitter/monitored_twitter_handles/[int monitored_twitter_handle_id]

Isolated FunctionResource Function

function get api/v2/channels/twitter/monitored_twitter_handles/[int monitored_twitter_handle_id](string accept) returns TwitterChannelResponse|error

Show Monitored Twitter Handle

Parameters

accept string (default "application/json") -

Return Type

TwitterChannelResponse|error - Success response

post api/v2/channels/twitter/tickets

Isolated FunctionResource Function

function post api/v2/channels/twitter/tickets() returns string|error

Create Ticket from Tweet

Return Type

string|error - description

get api/v2/channels/twitter/tickets/[int comment_id]/statuses

Isolated FunctionResource Function

function get api/v2/channels/twitter/tickets/[int comment_id]/statuses(string accept, string? ids) returns TwitterChannelTwicketStatusResponse|error

List Twicket statuses

Parameters

accept string (default "application/json") -

ids string? (default ()) - Optional comment ids to retrieve tweet information for only particular comments

Return Type

TwitterChannelTwicketStatusResponse|error - Success response

post api/v2/channels/voice/agents/[int agent_id]/tickets/[int ticket_id]/display

Isolated FunctionResource Function

function post api/v2/channels/voice/agents/[int agent_id]/tickets/[int ticket_id]/display(string accept) returns string|error

Open Ticket in Agent's Browser

Parameters

accept string (default "application/json") -

Return Type

string|error - Successful response

post api/v2/channels/voice/agents/[int agent_id]/users/[int user_id]/display

Isolated FunctionResource Function

function post api/v2/channels/voice/agents/[int agent_id]/users/[int user_id]/display(string accept) returns string|error

Open a User's Profile in an Agent's Browser

Parameters

accept string (default "application/json") -

Return Type

string|error - Successful response

post api/v2/channels/voice/tickets

Isolated FunctionResource Function

function post api/v2/channels/voice/tickets(TicketCreateVoicemailTicketRequest payload, string accept) returns TicketResponse|error

Create Ticket or Voicemail Ticket

Parameters

payload TicketCreateVoicemailTicketRequest -

accept string (default "application/json") -

Return Type

TicketResponse|error - Successful response

put api/v2/chat_file_redactions/[int ticket_id]

Isolated FunctionResource Function

function put api/v2/chat_file_redactions/[int ticket_id](string accept) returns TicketChatCommentRedactionResponse|error

Redact Chat Comment Attachment

Parameters

accept string (default "application/json") -

Return Type

TicketChatCommentRedactionResponse|error - Success response

put api/v2/chat_redactions/[int ticket_id]

Isolated FunctionResource Function

function put api/v2/chat_redactions/[int ticket_id](string accept) returns TicketChatCommentRedactionResponse|error

Redact Chat Comment

Parameters

accept string (default "application/json") -

Return Type

TicketChatCommentRedactionResponse|error - Success response

put api/v2/comment_redactions/[int ticket_comment_id]

Isolated FunctionResource Function

function put api/v2/comment_redactions/[int ticket_comment_id](string accept) returns TicketCommentResponse|error

Redact Ticket Comment In Agent Workspace

Parameters

accept string (default "application/json") -

Return Type

TicketCommentResponse|error - Success response

get api/v2/custom_objects

Isolated FunctionResource Function

function get api/v2/custom_objects() returns CustomObjectsResponse|error

List Custom Objects

Return Type

CustomObjectsResponse|error - Success response

post api/v2/custom_objects

Isolated FunctionResource Function

function post api/v2/custom_objects(CustomObjectsCreateRequest payload) returns CustomObjectResponse|error

Create Custom Object

Parameters

payload CustomObjectsCreateRequest -

Return Type

CustomObjectResponse|error - Created

get api/v2/custom_objects/[string custom_object_key]

Isolated FunctionResource Function

function get api/v2/custom_objects/[string custom_object_key](string accept) returns CustomObjectResponse|error

Show Custom Object

Parameters

accept string (default "application/json") -

Return Type

CustomObjectResponse|error - Custom Object

delete api/v2/custom_objects/[string custom_object_key]

Isolated FunctionResource Function

function delete api/v2/custom_objects/[string custom_object_key](string accept) returns error?

Delete Custom Object

Parameters

accept string (default "application/json") -

Return Type

error? - No content response

patch api/v2/custom_objects/[string custom_object_key]

Isolated FunctionResource Function

function patch api/v2/custom_objects/[string custom_object_key](string accept) returns CustomObjectResponse|error

Update Custom Object

Parameters

accept string (default "application/json") -

Return Type

CustomObjectResponse|error - Success response

get api/v2/custom_objects/[string custom_object_key]/fields

Isolated FunctionResource Function

function get api/v2/custom_objects/[string custom_object_key]/fields(string accept, boolean? include_standard_fields) returns CustomObjectFieldsResponse|error

List Custom Object Fields

Parameters

accept string (default "application/json") -

include_standard_fields boolean? (default ()) - Include standard fields if true. Exclude them if false

Return Type

CustomObjectFieldsResponse|error - Success response

post api/v2/custom_objects/[string custom_object_key]/fields

Isolated FunctionResource Function

function post api/v2/custom_objects/[string custom_object_key]/fields(CustomObjectFieldsCreateRequest payload, string accept) returns CustomObjectFieldResponse|error

Create Custom Object Field

Parameters

payload CustomObjectFieldsCreateRequest -

accept string (default "application/json") -

Return Type

CustomObjectFieldResponse|error - Created

get api/v2/custom_objects/[string custom_object_key]/fields/[string custom_object_field_key_or_id]

Isolated FunctionResource Function

function get api/v2/custom_objects/[string custom_object_key]/fields/[string custom_object_field_key_or_id](string accept) returns CustomObjectFieldResponse|error

Show Custom Object Field

Parameters

accept string (default "application/json") -

Return Type

CustomObjectFieldResponse|error - Custom Object Field

delete api/v2/custom_objects/[string custom_object_key]/fields/[string custom_object_field_key_or_id]

Isolated FunctionResource Function

function delete api/v2/custom_objects/[string custom_object_key]/fields/[string custom_object_field_key_or_id](string accept) returns error?

Delete Custom Object Field

Parameters

accept string (default "application/json") -

Return Type

error? - No content response

patch api/v2/custom_objects/[string custom_object_key]/fields/[string custom_object_field_key_or_id]

Isolated FunctionResource Function

function patch api/v2/custom_objects/[string custom_object_key]/fields/[string custom_object_field_key_or_id](string accept) returns CustomObjectFieldResponse|error

Update Custom Object Field

Parameters

accept string (default "application/json") -

Return Type

CustomObjectFieldResponse|error - Success response

put api/v2/custom_objects/[string custom_object_key]/fields/reorder

Isolated FunctionResource Function

function put api/v2/custom_objects/[string custom_object_key]/fields/reorder(string accept) returns string|error

Reorder Custom Fields of an Object

Parameters

accept string (default "application/json") -

Return Type

string|error - Reordered

post api/v2/custom_objects/[string custom_object_key]/jobs

Isolated FunctionResource Function

function post api/v2/custom_objects/[string custom_object_key]/jobs(CustomObjectRecordsBulkCreateRequest payload, string accept) returns CustomObjectRecordsJobsResponse|error

Custom Object Record Bulk Jobs

Parameters

payload CustomObjectRecordsBulkCreateRequest -

accept string (default "application/json") -

Return Type

CustomObjectRecordsJobsResponse|error - Created

get api/v2/custom_objects/[string custom_object_key]/limits/field_limit

Isolated FunctionResource Function

function get api/v2/custom_objects/[string custom_object_key]/limits/field_limit(string accept) returns CustomObjectLimitsResponse|error

Custom Object Fields Limit

Parameters

accept string (default "application/json") -

Return Type

CustomObjectLimitsResponse|error - Success response

get api/v2/custom_objects/[string custom_object_key]/records

Isolated FunctionResource Function

function get api/v2/custom_objects/[string custom_object_key]/records(string accept, string? filterIds, string? filterExternal_ids, string? sort, string? pageBefore, string? pageAfter, int? pageSize) returns CustomObjectRecordsResponse|error

List Custom Object Records

Parameters

accept string (default "application/json") -

filterIds string? (default ()) - Optional comma-separated list of ids to filter records by. If one or more ids are specified, only matching records are returned. The ids must be unique and are case sensitive.

filterExternal_ids string? (default ()) - Optional comma-separated list of external ids to filter records by. If one or more ids are specified, only matching records are returned. The ids must be unique and are case sensitive.

sort string? (default ()) - One of id, updated_at, -id, or -updated_at. The - denotes the sort will be descending.

pageBefore string? (default ()) - A pagination cursor that tells the endpoint which page to start on. It should be a meta.before_cursor value from a previous request. Note: page[before] and page[after] can't be used together in the same request.

pageAfter string? (default ()) - A pagination cursor that tells the endpoint which page to start on. It should be a meta.after_cursor value from a previous request. Note: page[before] and page[after] can't be used together in the same request.

pageSize int? (default ()) - Specifies how many records should be returned in the response. You can specify up to 100 records per page.

Return Type

CustomObjectRecordsResponse|error - Success response

post api/v2/custom_objects/[string custom_object_key]/records

Isolated FunctionResource Function

function post api/v2/custom_objects/[string custom_object_key]/records(CustomObjectRecordsCreateRequest payload, string accept) returns CustomObjectRecordResponse|error

Create Custom Object Record

Parameters

payload CustomObjectRecordsCreateRequest -

accept string (default "application/json") -

Return Type

CustomObjectRecordResponse|error - Created

delete api/v2/custom_objects/[string custom_object_key]/records

Isolated FunctionResource Function

function delete api/v2/custom_objects/[string custom_object_key]/records(string external_id, string accept) returns error?

Delete Custom Object Record by External Id

Parameters

external_id string - The external id of a custom object record

accept string (default "application/json") -

Return Type

error? - No content response

patch api/v2/custom_objects/[string custom_object_key]/records

Isolated FunctionResource Function

function patch api/v2/custom_objects/[string custom_object_key]/records(string external_id, CustomObjectRecordsUpsertRequest payload, string accept) returns CustomObjectRecordResponse|error

Set Custom Object Record by External Id

Parameters

external_id string - The external id of a custom object record

payload CustomObjectRecordsUpsertRequest -

accept string (default "application/json") -

Return Type

CustomObjectRecordResponse|error - Success

get api/v2/custom_objects/[string custom_object_key]/records/[string custom_object_record_id]

Isolated FunctionResource Function

function get api/v2/custom_objects/[string custom_object_key]/records/[string custom_object_record_id](string accept) returns CustomObjectRecordResponse|error

Show Custom Object Record

Parameters

accept string (default "application/json") -

Return Type

CustomObjectRecordResponse|error - Custom Object Record

delete api/v2/custom_objects/[string custom_object_key]/records/[string custom_object_record_id]

Isolated FunctionResource Function

function delete api/v2/custom_objects/[string custom_object_key]/records/[string custom_object_record_id](string accept) returns error?

Delete Custom Object Record

Parameters

accept string (default "application/json") -

Return Type

error? - No content response

patch api/v2/custom_objects/[string custom_object_key]/records/[string custom_object_record_id]

Isolated FunctionResource Function

function patch api/v2/custom_objects/[string custom_object_key]/records/[string custom_object_record_id](string accept) returns CustomObjectRecordResponse|error

Update Custom Object Record

Parameters

accept string (default "application/json") -

Return Type

CustomObjectRecordResponse|error - Success response

get api/v2/custom_objects/[string custom_object_key]/records/autocomplete

Isolated FunctionResource Function

function get api/v2/custom_objects/[string custom_object_key]/records/autocomplete(string accept, string? name, string? pageBefore, string? pageAfter, int? pageSize, string? field_id, string? 'source) returns CustomObjectRecordsResponse|error

Autocomplete Custom Object Record Search

Parameters

accept string (default "application/json") -

name string? (default ()) - Part of a name of the record you are searching for

pageBefore string? (default ()) - A pagination cursor that tells the endpoint which page to start on. It should be a meta.before_cursor value from a previous request. Note: page[before] and page[after] can't be used together in the same request.

pageAfter string? (default ()) - A pagination cursor that tells the endpoint which page to start on. It should be a meta.after_cursor value from a previous request. Note: page[before] and page[after] can't be used together in the same request.

pageSize int? (default ()) - The number of records to return in the response. You can specify up to 100 records per page.

field_id string? (default ()) - The id of the lookup field. If the field has a relationship filter, the filter is applied to the results. Must be used with source param.

'source string? (default ()) - One of "zen:user", "zen:ticket", "zen:organization", or "zen:custom_object:CUSTOM_OBJECT_KEY". Represents the object field_id belongs to. Must be used with field_id param.

Return Type

CustomObjectRecordsResponse|error - Success response

get api/v2/custom_objects/[string custom_object_key]/records/count

Isolated FunctionResource Function

function get api/v2/custom_objects/[string custom_object_key]/records/count(string accept) returns Inline_response_200_1|error

Count Custom Object Records

Parameters

accept string (default "application/json") -

Return Type

Inline_response_200_1|error - Success response

get api/v2/custom_objects/[string custom_object_key]/records/search

Isolated FunctionResource Function

function get api/v2/custom_objects/[string custom_object_key]/records/search(string accept, string? query, string? sort, string? pageBefore, string? pageAfter, int? pageSize) returns CustomObjectRecordsResponse|error

Search Custom Object Records

Parameters

accept string (default "application/json") -

query string? (default ()) - The query parameter is used to search text-based fields for records that match specific query terms. The query can be multiple words or numbers. Every record that matches the beginning of any word or number in the query string is returned.<br/><br/> For example, you might want to search for records related to Tesla vehicles: query=Tesla. In this example the API would return every record for the given custom object where any of the text fields contain the word 'Tesla'.<br/><br/> If needed, you could include multiple words or numbers in your search. For example: query=Tesla Honda 2020. This would be URL encoded as query=Tesla%20Honda%202020. In this example, the API would return every record for the custom object for which any of the text fields contained 'Tesla', 'Honda', or '2020'.

sort string? (default ()) - One of name, created_at, updated_at, -name, -created_at, or -updated_at. The - denotes the sort will be descending. Defaults to sorting by relevance.

pageBefore string? (default ()) - A pagination cursor that tells the endpoint which page to start on. It should be a meta.before_cursor value from a previous request. Note: page[before] and page[after] can't be used together in the same request.

pageAfter string? (default ()) - A pagination cursor that tells the endpoint which page to start on. It should be a meta.after_cursor value from a previous request. Note: page[before] and page[after] can't be used together in the same request.

pageSize int? (default ()) - Specifies how many records should be returned in the response. You can specify up to 100 records per page.

Return Type

CustomObjectRecordsResponse|error - Success response

get api/v2/custom_objects/limits/object_limit

Isolated FunctionResource Function

function get api/v2/custom_objects/limits/object_limit() returns CustomObjectLimitsResponse|error

Custom Objects Limit

Return Type

CustomObjectLimitsResponse|error - Success response

get api/v2/custom_objects/limits/record_limit

Isolated FunctionResource Function

function get api/v2/custom_objects/limits/record_limit() returns CustomObjectLimitsResponse|error

Custom Object Records Limit

Return Type

CustomObjectLimitsResponse|error - Success response

get api/v2/custom_roles

Isolated FunctionResource Function

function get api/v2/custom_roles() returns CustomRolesResponse|error

List Custom Roles

Return Type

CustomRolesResponse|error - Success response

post api/v2/custom_roles

Isolated FunctionResource Function

function post api/v2/custom_roles() returns CustomRoleResponse|error

Create Custom Role

Return Type

CustomRoleResponse|error - Created response

get api/v2/custom_roles/[int custom_role_id]

Isolated FunctionResource Function

function get api/v2/custom_roles/[int custom_role_id](string accept) returns CustomRoleResponse|error

Show Custom Role

Parameters

accept string (default "application/json") -

Return Type

CustomRoleResponse|error - Success response

put api/v2/custom_roles/[int custom_role_id]

Isolated FunctionResource Function

function put api/v2/custom_roles/[int custom_role_id](string accept) returns CustomRoleResponse|error

Update Custom Role

Parameters

accept string (default "application/json") -

Return Type

CustomRoleResponse|error - Success response

delete api/v2/custom_roles/[int custom_role_id]

Isolated FunctionResource Function

function delete api/v2/custom_roles/[int custom_role_id](string accept) returns error?

Delete Custom Role

Parameters

accept string (default "application/json") -

Return Type

error? - No Contetnt response

put api/v2/custom_status/default

Isolated FunctionResource Function

function put api/v2/custom_status/default(BulkUpdateDefaultCustomStatusRequest payload) returns BulkUpdateDefaultCustomStatusResponse|error

Bulk Update Default Custom Ticket Status

Parameters

payload BulkUpdateDefaultCustomStatusRequest -

Return Type

BulkUpdateDefaultCustomStatusResponse|error - Updated

get api/v2/custom_statuses

Isolated FunctionResource Function

function get api/v2/custom_statuses(string accept, string? status_categories, boolean? active, boolean? default) returns CustomStatusesResponse|error

List Custom Ticket Statuses

Parameters

accept string (default "application/json") -

status_categories string? (default ()) - Filter the list of custom ticket statuses by a comma-separated list of status categories

active boolean? (default ()) - If true, show only active custom ticket statuses. If false, show only inactive custom ticket statuses. If the filter is not used, show all custom ticket statuses

default boolean? (default ()) - If true, show only default custom ticket statuses. If false, show only non-default custom ticket statuses. If the filter is not used, show all custom ticket statuses

Return Type

CustomStatusesResponse|error - List custom ticket statuses

post api/v2/custom_statuses

Isolated FunctionResource Function

function post api/v2/custom_statuses(CustomStatusCreateRequest payload) returns CustomStatusResponse|error

Create Custom Ticket Status

Parameters

payload CustomStatusCreateRequest -

Return Type

CustomStatusResponse|error - Created

get api/v2/custom_statuses/[int custom_status_id]

Isolated FunctionResource Function

function get api/v2/custom_statuses/[int custom_status_id](string accept) returns CustomStatusResponse|error

Show Custom Ticket Status

Parameters

accept string (default "application/json") -

Return Type

CustomStatusResponse|error - Custom Status

put api/v2/custom_statuses/[int custom_status_id]

Isolated FunctionResource Function

function put api/v2/custom_statuses/[int custom_status_id](CustomStatusUpdateRequest payload, string accept) returns CustomStatusResponse|error

Update Custom Ticket Status

Parameters

payload CustomStatusUpdateRequest -

accept string (default "application/json") -

Return Type

CustomStatusResponse|error - Updated

get api/v2/deleted_tickets

Isolated FunctionResource Function

function get api/v2/deleted_tickets(string accept, "id"|"subject"|"deleted_at"? sort_by, "asc"|"desc"? sort_order) returns ListDeletedTicketsResponse|error

List Deleted Tickets

Parameters

accept string (default "application/json") -

sort_by "id"|"subject"|"deleted_at"? (default ()) - Sort by

sort_order "asc"|"desc"? (default ()) - Sort order. Defaults to "asc"

Return Type

ListDeletedTicketsResponse|error - Successful response

delete api/v2/deleted_tickets/[int ticket_id]

Isolated FunctionResource Function

function delete api/v2/deleted_tickets/[int ticket_id](string accept) returns JobStatusResponse|error

Delete Ticket Permanently

Parameters

accept string (default "application/json") -

Return Type

JobStatusResponse|error - Successful response

put api/v2/deleted_tickets/[int ticket_id]/restore

Isolated FunctionResource Function

function put api/v2/deleted_tickets/[int ticket_id]/restore(string accept) returns string|error

Restore a Previously Deleted Ticket

Parameters

accept string (default "application/json") -

Return Type

string|error - Empty response

delete api/v2/deleted_tickets/destroy_many

Isolated FunctionResource Function

function delete api/v2/deleted_tickets/destroy_many(string ids, string accept) returns JobStatusResponse|error

Delete Multiple Tickets Permanently

Parameters

ids string - Comma-separated list of ticket ids

accept string (default "application/json") -

Return Type

JobStatusResponse|error - Successful response

put api/v2/deleted_tickets/restore_many

Isolated FunctionResource Function

function put api/v2/deleted_tickets/restore_many(string ids, string accept) returns string|error

Restore Previously Deleted Tickets in Bulk

Parameters

ids string - Comma-separated list of ticket ids

accept string (default "application/json") -

Return Type

string|error - Empty response

get api/v2/deleted_users

Isolated FunctionResource Function

function get api/v2/deleted_users() returns DeletedUsersResponse|error

List Deleted Users

Return Type

DeletedUsersResponse|error - Success response

get api/v2/deleted_users/[int deleted_user_id]

Isolated FunctionResource Function

function get api/v2/deleted_users/[int deleted_user_id](string accept) returns DeletedUserResponse|error

Show Deleted User

Parameters

accept string (default "application/json") -

Return Type

DeletedUserResponse|error - Success response

delete api/v2/deleted_users/[int deleted_user_id]

Isolated FunctionResource Function

function delete api/v2/deleted_users/[int deleted_user_id](string accept) returns DeletedUserResponse|error

Permanently Delete User

Parameters

accept string (default "application/json") -

Return Type

DeletedUserResponse|error - Success response

get api/v2/deleted_users/count

Isolated FunctionResource Function

function get api/v2/deleted_users/count() returns CountResponse|error

Count Deleted Users

Return Type

CountResponse|error - Success response

get api/v2/dynamic_content/items

Isolated FunctionResource Function

function get api/v2/dynamic_content/items() returns DynamicContentsResponse|error

List Items

Return Type

DynamicContentsResponse|error - Success response

post api/v2/dynamic_content/items

Isolated FunctionResource Function

function post api/v2/dynamic_content/items() returns DynamicContentResponse|error

Create Item

Return Type

DynamicContentResponse|error - Created response

get api/v2/dynamic_content/items/[int dynamic_content_item_id]

Isolated FunctionResource Function

function get api/v2/dynamic_content/items/[int dynamic_content_item_id](string accept) returns DynamicContentResponse|error

Show Item

Parameters

accept string (default "application/json") -

Return Type

DynamicContentResponse|error - Success response

put api/v2/dynamic_content/items/[int dynamic_content_item_id]

Isolated FunctionResource Function

function put api/v2/dynamic_content/items/[int dynamic_content_item_id](string accept) returns DynamicContentResponse|error

Update Item

Parameters

accept string (default "application/json") -

Return Type

DynamicContentResponse|error - Success response

delete api/v2/dynamic_content/items/[int dynamic_content_item_id]

Isolated FunctionResource Function

function delete api/v2/dynamic_content/items/[int dynamic_content_item_id](string accept) returns error?

Delete Item

Parameters

accept string (default "application/json") -

Return Type

error? - No Content response

get api/v2/dynamic_content/items/[int dynamic_content_item_id]/variants

Isolated FunctionResource Function

function get api/v2/dynamic_content/items/[int dynamic_content_item_id]/variants(string accept) returns DynamicContentVariantsResponse|error

List Variants

Parameters

accept string (default "application/json") -

Return Type

DynamicContentVariantsResponse|error - Success response

post api/v2/dynamic_content/items/[int dynamic_content_item_id]/variants

Isolated FunctionResource Function

function post api/v2/dynamic_content/items/[int dynamic_content_item_id]/variants(string accept) returns DynamicContentVariantResponse|error

Create Variant

Parameters

accept string (default "application/json") -

Return Type

DynamicContentVariantResponse|error - Created response

get api/v2/dynamic_content/items/[int dynamic_content_item_id]/variants/[int dynammic_content_variant_id]

Isolated FunctionResource Function

function get api/v2/dynamic_content/items/[int dynamic_content_item_id]/variants/[int dynammic_content_variant_id](string accept) returns DynamicContentVariantResponse|error

Show Variant

Parameters

accept string (default "application/json") -

Return Type

DynamicContentVariantResponse|error - Success response

put api/v2/dynamic_content/items/[int dynamic_content_item_id]/variants/[int dynammic_content_variant_id]

Isolated FunctionResource Function

function put api/v2/dynamic_content/items/[int dynamic_content_item_id]/variants/[int dynammic_content_variant_id](string accept) returns DynamicContentVariantResponse|error

Update Variant

Parameters

accept string (default "application/json") -

Return Type

DynamicContentVariantResponse|error - Success response

delete api/v2/dynamic_content/items/[int dynamic_content_item_id]/variants/[int dynammic_content_variant_id]

Isolated FunctionResource Function

function delete api/v2/dynamic_content/items/[int dynamic_content_item_id]/variants/[int dynammic_content_variant_id](string accept) returns error?

Delete Variant

Parameters

accept string (default "application/json") -

Return Type

error? - No Content response

post api/v2/dynamic_content/items/[int dynamic_content_item_id]/variants/create_many

Isolated FunctionResource Function

function post api/v2/dynamic_content/items/[int dynamic_content_item_id]/variants/create_many(string accept) returns DynamicContentVariantsResponse|error

Create Many Variants

Parameters

accept string (default "application/json") -

Return Type

DynamicContentVariantsResponse|error - Created response

put api/v2/dynamic_content/items/[int dynamic_content_item_id]/variants/update_many

Isolated FunctionResource Function

function put api/v2/dynamic_content/items/[int dynamic_content_item_id]/variants/update_many(string accept) returns DynamicContentVariantsResponse|error

Update Many Variants

Parameters

accept string (default "application/json") -

Return Type

DynamicContentVariantsResponse|error - Success response

get api/v2/dynamic_content/items/show_many

Isolated FunctionResource Function

function get api/v2/dynamic_content/items/show_many(string accept, string? identifiers) returns DynamicContentsResponse|error

Show Many Items

Parameters

accept string (default "application/json") -

identifiers string? (default ()) - Identifiers for the dynamic contents

Return Type

DynamicContentsResponse|error - Success response

get api/v2/group_memberships

Isolated FunctionResource Function

function get api/v2/group_memberships() returns GroupMembershipsResponse|error

List Memberships

Return Type

GroupMembershipsResponse|error - Success response

post api/v2/group_memberships

Isolated FunctionResource Function

function post api/v2/group_memberships() returns GroupMembershipResponse|error

Create Membership

Return Type

GroupMembershipResponse|error - Created response

get api/v2/group_memberships/[int group_membership_id]

Isolated FunctionResource Function

function get api/v2/group_memberships/[int group_membership_id](string accept) returns GroupMembershipResponse|error

Show Membership

Parameters

accept string (default "application/json") -

Return Type

GroupMembershipResponse|error - Success response

delete api/v2/group_memberships/[int group_membership_id]

Isolated FunctionResource Function

function delete api/v2/group_memberships/[int group_membership_id](string accept) returns error?

Delete Membership

Parameters

accept string (default "application/json") -

Return Type

error? - No content response

get api/v2/group_memberships/assignable

Isolated FunctionResource Function

function get api/v2/group_memberships/assignable() returns GroupMembershipsResponse|error

List Assignable Memberships

Return Type

GroupMembershipsResponse|error - Success response

post api/v2/group_memberships/create_many

Isolated FunctionResource Function

function post api/v2/group_memberships/create_many() returns JobStatusResponse|error

Bulk Create Memberships

Return Type

JobStatusResponse|error - Success response

delete api/v2/group_memberships/destroy_many

Isolated FunctionResource Function

function delete api/v2/group_memberships/destroy_many(string accept, string? ids) returns JobStatusResponse|error

Bulk Delete Memberships

Parameters

accept string (default "application/json") -

ids string? (default ()) - Id of the group memberships to delete. Comma separated

Return Type

JobStatusResponse|error - Success response

get api/v2/group_slas/policies

Isolated FunctionResource Function

function get api/v2/group_slas/policies() returns GroupSLAPoliciesResponse|error

List Group SLA Policies

Return Type

GroupSLAPoliciesResponse|error - Success response

post api/v2/group_slas/policies

Isolated FunctionResource Function

function post api/v2/group_slas/policies() returns GroupSLAPolicyResponse|error

Create Group SLA Policy

Return Type

GroupSLAPolicyResponse|error - Created response

get api/v2/group_slas/policies/[int group_sla_policy_id]

Isolated FunctionResource Function

function get api/v2/group_slas/policies/[int group_sla_policy_id](string accept) returns GroupSLAPolicyResponse|error

Show Group SLA Policy

Parameters

accept string (default "application/json") -

Return Type

GroupSLAPolicyResponse|error - Success response

put api/v2/group_slas/policies/[int group_sla_policy_id]

Isolated FunctionResource Function

function put api/v2/group_slas/policies/[int group_sla_policy_id](string accept) returns GroupSLAPolicyResponse|error

Update Group SLA Policy

Parameters

accept string (default "application/json") -

Return Type

GroupSLAPolicyResponse|error - Success response

delete api/v2/group_slas/policies/[int group_sla_policy_id]

Isolated FunctionResource Function

function delete api/v2/group_slas/policies/[int group_sla_policy_id](string accept) returns error?

Delete Group SLA Policy

Parameters

accept string (default "application/json") -

Return Type

error? - No Content response

get api/v2/group_slas/policies/definitions

Isolated FunctionResource Function

function get api/v2/group_slas/policies/definitions() returns GroupSLAPolicyFilterDefinitionResponse|error

Retrieve Supported Filter Definition Items

Return Type

GroupSLAPolicyFilterDefinitionResponse|error - Success response

put api/v2/group_slas/policies/reorder

Isolated FunctionResource Function

function put api/v2/group_slas/policies/reorder(string accept, string[]? group_sla_policy_ids) returns string|error

Reorder Group SLA Policies

Parameters

accept string (default "application/json") -

group_sla_policy_ids string[]? (default ()) - The ids of the Group SLA policies to reorder

Return Type

string|error - Success response

get api/v2/groups

Isolated FunctionResource Function

function get api/v2/groups(string accept, boolean? exclude_deleted) returns GroupsResponse|error

List Groups

Parameters

accept string (default "application/json") -

exclude_deleted boolean? (default ()) - Whether to exclude deleted entities

Return Type

GroupsResponse|error - Success response

post api/v2/groups

Isolated FunctionResource Function

function post api/v2/groups() returns GroupResponse|error

Create Group

Return Type

GroupResponse|error - Created response

get api/v2/groups/[int group_id]

Isolated FunctionResource Function

function get api/v2/groups/[int group_id](string accept) returns GroupResponse|error

Show Group

Parameters

accept string (default "application/json") -

Return Type

GroupResponse|error - Success response

put api/v2/groups/[int group_id]

Isolated FunctionResource Function

function put api/v2/groups/[int group_id](string accept) returns GroupResponse|error

Update Group

Parameters

accept string (default "application/json") -

Return Type

GroupResponse|error - Success response

delete api/v2/groups/[int group_id]

Isolated FunctionResource Function

function delete api/v2/groups/[int group_id](string accept) returns error?

Delete Group

Parameters

accept string (default "application/json") -

Return Type

error? - No content response

get api/v2/groups/[int group_id]/memberships

Isolated FunctionResource Function

function get api/v2/groups/[int group_id]/memberships(string accept) returns GroupMembershipsResponse|error

List Memberships

Parameters

accept string (default "application/json") -

Return Type

GroupMembershipsResponse|error - Success response

get api/v2/groups/assignable

Isolated FunctionResource Function

function get api/v2/groups/assignable() returns GroupsResponse|error

List Assignable Groups

Return Type

GroupsResponse|error - Success response

get api/v2/groups/count

Isolated FunctionResource Function

function get api/v2/groups/count(string accept) returns GroupsCountObject|error

Count Groups

Parameters

accept string (default "application/json") -

Return Type

GroupsCountObject|error - Success response

post api/v2/imports/tickets

Isolated FunctionResource Function

function post api/v2/imports/tickets(TicketImportRequest payload, string accept, boolean? archive_immediately) returns TicketResponse|error

Ticket Import

Parameters

payload TicketImportRequest -

accept string (default "application/json") -

archive_immediately boolean? (default ()) - If true, any ticket created with a closed status bypasses the normal ticket lifecycle and will be created directly in your ticket archive

Return Type

TicketResponse|error - Successfully created

post api/v2/imports/tickets/create_many

Isolated FunctionResource Function

function post api/v2/imports/tickets/create_many(TicketBulkImportRequest payload, string accept, boolean? archive_immediately) returns JobStatusResponse|error

Ticket Bulk Import

Parameters

payload TicketBulkImportRequest -

accept string (default "application/json") -

archive_immediately boolean? (default ()) - If true, any ticket created with a closed status bypasses the normal ticket lifecycle and will be created directly in your ticket archive

Return Type

JobStatusResponse|error - Successful response

get api/v2/incremental/[string incremental_resource]/sample

Isolated FunctionResource Function

function get api/v2/incremental/[string incremental_resource]/sample(int start_time, string accept) returns TimeBasedExportIncrementalTicketsResponse|error

Incremental Sample Export

Parameters

start_time int - The time to start the incremental export from. Must be at least one minute in the past. Data isn't provided for the most recent minute

accept string (default "application/json") -

Return Type

TimeBasedExportIncrementalTicketsResponse|error - Success response

get api/v2/incremental/organizations

Isolated FunctionResource Function

function get api/v2/incremental/organizations(int start_time, string accept) returns ExportIncrementalOrganizationsResponse|error

Incremental Organization Export

Parameters

start_time int - The time to start the incremental export from. Must be at least one minute in the past. Data isn't provided for the most recent minute

accept string (default "application/json") -

Return Type

ExportIncrementalOrganizationsResponse|error - Success response

get api/v2/incremental/routing/attribute_values

Isolated FunctionResource Function

function get api/v2/incremental/routing/attribute_values() returns IncrementalSkillBasedRouting|error

Incremental Attributes Values Export

Return Type

IncrementalSkillBasedRouting|error - Success response

get api/v2/incremental/routing/attributes

Isolated FunctionResource Function

function get api/v2/incremental/routing/attributes() returns IncrementalSkillBasedRouting|error

Incremental Attributes Export

Return Type

IncrementalSkillBasedRouting|error - Success response

get api/v2/incremental/routing/instance_values

Isolated FunctionResource Function

function get api/v2/incremental/routing/instance_values() returns IncrementalSkillBasedRouting|error

Incremental Instance Values Export

Return Type

IncrementalSkillBasedRouting|error - Success response

get api/v2/incremental/ticket_events

Isolated FunctionResource Function

function get api/v2/incremental/ticket_events(int start_time, string accept) returns ExportIncrementalTicketEventsResponse|error

Incremental Ticket Event Export

Parameters

start_time int - The time to start the incremental export from. Must be at least one minute in the past. Data isn't provided for the most recent minute

accept string (default "application/json") -

Return Type

ExportIncrementalTicketEventsResponse|error - Success response

get api/v2/incremental/ticket_metric_events

Isolated FunctionResource Function

function get api/v2/incremental/ticket_metric_events(int start_time, string accept) returns TicketMetricEventsResponse|error

List Ticket Metric Events

Parameters

start_time int - The Unix UTC epoch time of the oldest event you're interested in. Example: 1332034771.

accept string (default "application/json") -

Return Type

TicketMetricEventsResponse|error - Successful response

get api/v2/incremental/tickets

Isolated FunctionResource Function

function get api/v2/incremental/tickets(int start_time, string accept) returns TimeBasedExportIncrementalTicketsResponse|error

Incremental Ticket Export, Time Based

Parameters

start_time int - The time to start the incremental export from. Must be at least one minute in the past. Data isn't provided for the most recent minute

accept string (default "application/json") -

Return Type

TimeBasedExportIncrementalTicketsResponse|error - Success response

get api/v2/incremental/tickets/cursor

Isolated FunctionResource Function

function get api/v2/incremental/tickets/cursor(int start_time, string accept, string? cursor) returns CursorBasedExportIncrementalTicketsResponse|error

Incremental Ticket Export, Cursor Based

Parameters

start_time int - The time to start the incremental export from. Must be at least one minute in the past. Data isn't provided for the most recent minute

accept string (default "application/json") -

cursor string? (default ()) - The cursor pointer to work with for all subsequent exports after the initial request

Return Type

CursorBasedExportIncrementalTicketsResponse|error - Success response

get api/v2/incremental/users

Isolated FunctionResource Function

function get api/v2/incremental/users(int start_time, string accept, int? per_page) returns TimeBasedExportIncrementalUsersResponse|error

Incremental User Export, Time Based

Parameters

start_time int - The time to start the incremental export from. Must be at least one minute in the past. Data isn't provided for the most recent minute

accept string (default "application/json") -

per_page int? (default ()) - The number of records to return per page

Return Type

TimeBasedExportIncrementalUsersResponse|error - Success response

get api/v2/incremental/users/cursor

Isolated FunctionResource Function

function get api/v2/incremental/users/cursor(int start_time, string accept, string? cursor, int? per_page) returns CursorBasedExportIncrementalUsersResponse|error

Incremental User Export, Cursor Based

Parameters

start_time int - The time to start the incremental export from. Must be at least one minute in the past. Data isn't provided for the most recent minute

accept string (default "application/json") -

cursor string? (default ()) - The cursor pointer to work with for all subsequent exports after the initial request

per_page int? (default ()) - The number of records to return per page

Return Type

CursorBasedExportIncrementalUsersResponse|error - Success response

get api/v2/job_statuses

Isolated FunctionResource Function

function get api/v2/job_statuses() returns JobStatusesResponse|error

List Job Statuses

Return Type

JobStatusesResponse|error - Success Response

get api/v2/job_statuses/[string job_status_id]

Isolated FunctionResource Function

function get api/v2/job_statuses/[string job_status_id](string accept) returns JobStatusResponse|error

Show Job Status

Parameters

accept string (default "application/json") -

Return Type

JobStatusResponse|error - Success Response

get api/v2/job_statuses/show_many

Isolated FunctionResource Function

function get api/v2/job_statuses/show_many(string ids, string accept) returns JobStatusesResponse|error

Show Many Job Statuses

Parameters

ids string - Comma-separated list of job status ids.

accept string (default "application/json") -

Return Type

JobStatusesResponse|error - Success Response

get api/v2/locales

Isolated FunctionResource Function

function get api/v2/locales() returns LocalesResponse|error

List Locales

Return Type

LocalesResponse|error - Success response

get api/v2/locales/[string locale_id]

Isolated FunctionResource Function

function get api/v2/locales/[string locale_id](string accept) returns LocaleResponse|error

Show Locale

Parameters

accept string (default "application/json") -

Return Type

LocaleResponse|error - Success Response

get api/v2/locales/agent

Isolated FunctionResource Function

function get api/v2/locales/agent() returns LocalesResponse|error

List Locales for Agent

Return Type

LocalesResponse|error - Success response

get api/v2/locales/current

Isolated FunctionResource Function

function get api/v2/locales/current() returns LocaleResponse|error

Show Current Locale

Return Type

LocaleResponse|error - Success response

get api/v2/locales/detect_best_locale

Isolated FunctionResource Function

function get api/v2/locales/detect_best_locale() returns LocaleResponse|error

Detect Best Language for User

Return Type

LocaleResponse|error - Success response

get api/v2/locales/'public

Isolated FunctionResource Function

function get api/v2/locales/'public() returns LocalesResponse|error

List Available Public Locales

Return Type

LocalesResponse|error - Success response

get api/v2/macros

Isolated FunctionResource Function

function get api/v2/macros(string accept, string? include, string? access, boolean? active, int? category, int? group_id, boolean? only_viewable, string? sort_by, string? sort_order) returns MacrosResponse|error

List Macros

Parameters

accept string (default "application/json") -

include string? (default ()) - A sideload to include in the response. See Sideloads

access string? (default ()) - Filter macros by access. Possible values are "personal", "agents", "shared", or "account". The "agents" value returns all personal macros for the account's agents and is only available to admins.

active boolean? (default ()) - Filter by active macros if true or inactive macros if false

category int? (default ()) - Filter macros by category

group_id int? (default ()) - Filter macros by group

only_viewable boolean? (default ()) - If true, returns only macros that can be applied to tickets. If false, returns all macros the current user can manage. Default is false

sort_by string? (default ()) - Possible values are alphabetical, "created_at", "updated_at", "usage_1h", "usage_24h", "usage_7d", or "usage_30d". Defaults to alphabetical

sort_order string? (default ()) - One of "asc" or "desc". Defaults to "asc" for alphabetical and position sort, "desc" for all others

Return Type

MacrosResponse|error - Success Response

post api/v2/macros

Isolated FunctionResource Function

function post api/v2/macros(V2_macros_body payload) returns Inline_response_200_2|error

Create Macro

Parameters

payload V2_macros_body -

Return Type

Inline_response_200_2|error - OK

get api/v2/macros/[int macro_id]

Isolated FunctionResource Function

function get api/v2/macros/[int macro_id](string accept) returns MacroResponse|error

Show Macro

Parameters

accept string (default "application/json") -

Return Type

MacroResponse|error - Success Response

put api/v2/macros/[int macro_id]

Isolated FunctionResource Function

function put api/v2/macros/[int macro_id](Macros_macro_id_body payload, string accept) returns Inline_response_200_2|error

Update Macro

Parameters

payload Macros_macro_id_body -

accept string (default "application/json") -

Return Type

Inline_response_200_2|error - OK

delete api/v2/macros/[int macro_id]

Isolated FunctionResource Function

function delete api/v2/macros/[int macro_id](string accept) returns error?

Delete Macro

Parameters

accept string (default "application/json") -

Return Type

error? - No Content

get api/v2/macros/[int macro_id]/apply

Isolated FunctionResource Function

function get api/v2/macros/[int macro_id]/apply(string accept) returns MacroApplyTicketResponse|error

Show Changes to Ticket

Parameters

accept string (default "application/json") -

Return Type

MacroApplyTicketResponse|error - Success Response

get api/v2/macros/[int macro_id]/attachments

Isolated FunctionResource Function

function get api/v2/macros/[int macro_id]/attachments(string accept) returns MacroAttachmentsResponse|error

List Macro Attachments

Parameters

accept string (default "application/json") -

Return Type

MacroAttachmentsResponse|error - Success Response

post api/v2/macros/[int macro_id]/attachments

Isolated FunctionResource Function

function post api/v2/macros/[int macro_id]/attachments(string accept) returns MacroAttachmentResponse|error

Create Macro Attachment

Parameters

accept string (default "application/json") -

Return Type

MacroAttachmentResponse|error - Success Response

get api/v2/macros/actions

Isolated FunctionResource Function

function get api/v2/macros/actions() returns Inline_response_200_3|error

List Supported Actions for Macros

Return Type

Inline_response_200_3|error - Success Response

get api/v2/macros/active

Isolated FunctionResource Function

function get api/v2/macros/active(string accept, string? include, string? access, int? category, int? group_id, string? sort_by, string? sort_order) returns MacrosResponse|error

List Active Macros

Parameters

accept string (default "application/json") -

include string? (default ()) - A sideload to include in the response. See Sideloads

access string? (default ()) - Filter macros by access. Possible values are "personal", "agents", "shared", or "account". The "agents" value returns all personal macros for the account's agents and is only available to admins.

category int? (default ()) - Filter macros by category

group_id int? (default ()) - Filter macros by group

sort_by string? (default ()) - Possible values are alphabetical, "created_at", "updated_at", "usage_1h", "usage_24h", "usage_7d", or "usage_30d". Defaults to alphabetical

sort_order string? (default ()) - One of "asc" or "desc". Defaults to "asc" for alphabetical and position sort, "desc" for all others

Return Type

MacrosResponse|error - Success Response

post api/v2/macros/attachments

Isolated FunctionResource Function

function post api/v2/macros/attachments() returns MacroAttachmentResponse|error

Create Unassociated Macro Attachment

Return Type

MacroAttachmentResponse|error - Created Response

get api/v2/macros/attachments/[int attachment_id]

Isolated FunctionResource Function

function get api/v2/macros/attachments/[int attachment_id](string accept) returns MacroAttachmentResponse|error

Show Macro Attachment

Parameters

accept string (default "application/json") -

Return Type

MacroAttachmentResponse|error - Success Response

get api/v2/macros/categories

Isolated FunctionResource Function

function get api/v2/macros/categories() returns MacroCategoriesResponse|error

List Macro Categories

Return Type

MacroCategoriesResponse|error - Success Response

get api/v2/macros/definitions

Isolated FunctionResource Function

function get api/v2/macros/definitions() returns Inline_response_200_4|error

List Macro Action Definitions

Return Type

Inline_response_200_4|error - Success Response

delete api/v2/macros/destroy_many

Isolated FunctionResource Function

function delete api/v2/macros/destroy_many(int[] ids, string accept) returns error?

Bulk Delete Macros

Parameters

ids int[] - The IDs of the macros to delete

accept string (default "application/json") -

Return Type

error? - No Content

get api/v2/macros/'new

Isolated FunctionResource Function

function get api/v2/macros/'new(int macro_id, int ticket_id, string accept) returns MacroResponse|error

Show Macro Replica

Parameters

macro_id int - The ID of the macro to replicate

ticket_id int - The ID of the ticket from which to build a macro replica

accept string (default "application/json") -

Return Type

MacroResponse|error - Success Response

get api/v2/macros/search

Isolated FunctionResource Function

function get api/v2/macros/search(string query, string accept, string? include, string? access, boolean? active, int? category, int? group_id, boolean? only_viewable, string? sort_by, string? sort_order) returns MacrosResponse|error

Search Macros

Parameters

query string - Query string used to find macros with matching titles

accept string (default "application/json") -

include string? (default ()) - A sideload to include in the response. See Sideloads

access string? (default ()) - Filter macros by access. Possible values are "personal", "agents", "shared", or "account". The "agents" value returns all personal macros for the account's agents and is only available to admins.

active boolean? (default ()) - Filter by active macros if true or inactive macros if false

category int? (default ()) - Filter macros by category

group_id int? (default ()) - Filter macros by group

only_viewable boolean? (default ()) - If true, returns only macros that can be applied to tickets. If false, returns all macros the current user can manage. Default is false

sort_by string? (default ()) - Possible values are alphabetical, "created_at", "updated_at", "usage_1h", "usage_24h", "usage_7d", or "usage_30d". Defaults to alphabetical

sort_order string? (default ()) - One of "asc" or "desc". Defaults to "asc" for alphabetical and position sort, "desc" for all others

Return Type

MacrosResponse|error - Success Response

put api/v2/macros/update_many

Isolated FunctionResource Function

function put api/v2/macros/update_many(MacroUpdateManyInput payload) returns MacrosResponse|error

Update Many Macros

Parameters

payload MacroUpdateManyInput -

Return Type

MacrosResponse|error - Success Response

get api/v2/object_layouts/[string object_type]/essentials_card

Isolated FunctionResource Function

function get api/v2/object_layouts/[string object_type]/essentials_card(string accept) returns EssentialsCardResponse|error

Show Essentials Card

Parameters

accept string (default "application/json") -

Return Type

EssentialsCardResponse|error - Success response

put api/v2/object_layouts/[string object_type]/essentials_card

Isolated FunctionResource Function

function put api/v2/object_layouts/[string object_type]/essentials_card(string accept) returns EssentialsCardResponse|error

Update Essentials Card

Parameters

accept string (default "application/json") -

Return Type

EssentialsCardResponse|error - Success response

delete api/v2/object_layouts/[string object_type]/essentials_card

Isolated FunctionResource Function

function delete api/v2/object_layouts/[string object_type]/essentials_card(string accept) returns error?

Delete Essentials Card

Parameters

accept string (default "application/json") -

Return Type

error? - Success response

get api/v2/object_layouts/essentials_cards

Isolated FunctionResource Function

function get api/v2/object_layouts/essentials_cards() returns EssentialsCardsResponse|error

List of Essentials Cards

Return Type

EssentialsCardsResponse|error - Success response

get api/v2/organization_fields

Isolated FunctionResource Function

function get api/v2/organization_fields() returns OrganizationFieldsResponse|error

List Organization Fields

Return Type

OrganizationFieldsResponse|error - Success response

post api/v2/organization_fields

Isolated FunctionResource Function

function post api/v2/organization_fields() returns OrganizationFieldResponse|error

Create Organization Field

Return Type

OrganizationFieldResponse|error - Created response

get api/v2/organization_fields/[Organization_field_id organization_field_id]

Isolated FunctionResource Function

function get api/v2/organization_fields/[Organization_field_id organization_field_id](string accept) returns OrganizationFieldResponse|error

Show Organization Field

Parameters

accept string (default "application/json") -

Return Type

OrganizationFieldResponse|error - Success response

put api/v2/organization_fields/[Organization_field_id organization_field_id]

Isolated FunctionResource Function

function put api/v2/organization_fields/[Organization_field_id organization_field_id](string accept) returns OrganizationFieldResponse|error

Update Organization Field

Parameters

accept string (default "application/json") -

Return Type

OrganizationFieldResponse|error - Success response

delete api/v2/organization_fields/[Organization_field_id organization_field_id]

Isolated FunctionResource Function

function delete api/v2/organization_fields/[Organization_field_id organization_field_id](string accept) returns error?

Delete Organization Field

Parameters

accept string (default "application/json") -

Return Type

error? - No Content response

put api/v2/organization_fields/reorder

Isolated FunctionResource Function

function put api/v2/organization_fields/reorder() returns string|error

Reorder Organization Field

Return Type

string|error - Success response

get api/v2/organization_memberships

Isolated FunctionResource Function

function get api/v2/organization_memberships() returns OrganizationMembershipsResponse|error

List Memberships

Return Type

OrganizationMembershipsResponse|error - Success response

post api/v2/organization_memberships

Isolated FunctionResource Function

function post api/v2/organization_memberships() returns OrganizationMembershipResponse|error

Create Membership

Return Type

OrganizationMembershipResponse|error - Created response

get api/v2/organization_memberships/[int organization_membership_id]

Isolated FunctionResource Function

function get api/v2/organization_memberships/[int organization_membership_id](string accept) returns OrganizationMembershipResponse|error

Show Membership

Parameters

accept string (default "application/json") -

Return Type

OrganizationMembershipResponse|error - Success response

delete api/v2/organization_memberships/[int organization_membership_id]

Isolated FunctionResource Function

function delete api/v2/organization_memberships/[int organization_membership_id](string accept) returns error?

Delete Membership

Parameters

accept string (default "application/json") -

Return Type

error? - No Content response

post api/v2/organization_memberships/create_many

Isolated FunctionResource Function

function post api/v2/organization_memberships/create_many() returns JobStatusResponse|error

Create Many Memberships

Return Type

JobStatusResponse|error - Success response

delete api/v2/organization_memberships/destroy_many

Isolated FunctionResource Function

function delete api/v2/organization_memberships/destroy_many(string accept, int[]? ids) returns JobStatusResponse|error

Bulk Delete Memberships

Parameters

accept string (default "application/json") -

ids int[]? (default ()) - The IDs of the organization memberships to delete

Return Type

JobStatusResponse|error - Success response

get api/v2/organization_subscriptions

Isolated FunctionResource Function

function get api/v2/organization_subscriptions() returns OrganizationSubscriptionsResponse|error

List Organization Subscriptions

Return Type

OrganizationSubscriptionsResponse|error - Successful response

post api/v2/organization_subscriptions

Isolated FunctionResource Function

function post api/v2/organization_subscriptions(OrganizationSubscriptionCreateRequest payload) returns OrganizationSubscriptionResponse|error

Create Organization Subscription

Parameters

payload OrganizationSubscriptionCreateRequest -

Return Type

OrganizationSubscriptionResponse|error - Successful response

get api/v2/organization_subscriptions/[int organization_subscription_id]

Isolated FunctionResource Function

function get api/v2/organization_subscriptions/[int organization_subscription_id](string accept) returns OrganizationSubscriptionResponse|error

Show Organization Subscription

Parameters

accept string (default "application/json") -

Return Type

OrganizationSubscriptionResponse|error - Successful response

delete api/v2/organization_subscriptions/[int organization_subscription_id]

Isolated FunctionResource Function

function delete api/v2/organization_subscriptions/[int organization_subscription_id](string accept) returns error?

Delete Organization Subscription

Parameters

accept string (default "application/json") -

Return Type

error? - No content

get api/v2/organizations

Isolated FunctionResource Function

function get api/v2/organizations() returns OrganizationsResponse|error

List Organizations

Return Type

OrganizationsResponse|error - Success response

post api/v2/organizations

Isolated FunctionResource Function

function post api/v2/organizations() returns OrganizationResponse|error

Create Organization

Return Type

OrganizationResponse|error - Created

get api/v2/organizations/[int organization_id]

Isolated FunctionResource Function

function get api/v2/organizations/[int organization_id](string accept) returns OrganizationResponse|error

Show Organization

Parameters

accept string (default "application/json") -

Return Type

OrganizationResponse|error - Success response

put api/v2/organizations/[int organization_id]

Isolated FunctionResource Function

function put api/v2/organizations/[int organization_id](string accept) returns OrganizationResponse|error

Update Organization

Parameters

accept string (default "application/json") -

Return Type

OrganizationResponse|error - Success response

delete api/v2/organizations/[int organization_id]

Isolated FunctionResource Function

function delete api/v2/organizations/[int organization_id](string accept) returns error?

Delete Organization

Parameters

accept string (default "application/json") -

Return Type

error? - No Content Response

Isolated FunctionResource Function

function get api/v2/organizations/[int organization_id]/related(string accept) returns OrganizationsRelatedResponse|error

Show Organization's Related Information

Parameters

accept string (default "application/json") -

Return Type

OrganizationsRelatedResponse|error - Success response

get api/v2/organizations/autocomplete

Isolated FunctionResource Function

function get api/v2/organizations/autocomplete(string name, string accept, string? field_id, string? 'source) returns OrganizationsResponse|error

Autocomplete Organizations

Parameters

name string - A substring of an organization to search for

accept string (default "application/json") -

field_id string? (default ()) - The id of a lookup relationship field. The type of field is determined by the source param

'source string? (default ()) - If a field_id is provided, this specifies the type of the field. For example, if the field is on a "zen:user", it references a field on a user

Return Type

OrganizationsResponse|error - Success response

get api/v2/organizations/count

Isolated FunctionResource Function

function get api/v2/organizations/count() returns CountOrganizationResponse|error

Count Organizations

Return Type

CountOrganizationResponse|error - Success response

post api/v2/organizations/create_many

Isolated FunctionResource Function

function post api/v2/organizations/create_many() returns JobStatusResponse|error

Create Many Organizations

Return Type

JobStatusResponse|error - Success response

post api/v2/organizations/create_or_update

Isolated FunctionResource Function

function post api/v2/organizations/create_or_update() returns OrganizationResponse|error

Create Or Update Organization

Return Type

OrganizationResponse|error - Success response

delete api/v2/organizations/destroy_many

Isolated FunctionResource Function

function delete api/v2/organizations/destroy_many(string accept, string? ids, string? external_ids) returns JobStatusResponse|error

Bulk Delete Organizations

Parameters

accept string (default "application/json") -

ids string? (default ()) - A list of organization ids

external_ids string? (default ()) - A list of external ids

Return Type

JobStatusResponse|error - Success response

get api/v2/organizations/search

Isolated FunctionResource Function

function get api/v2/organizations/search(string accept, int? external_id, string? name) returns OrganizationsResponse|error

Search Organizations

Parameters

accept string (default "application/json") -

external_id int? (default ()) - The external id of an organization

name string? (default ()) - The name of an organization

Return Type

OrganizationsResponse|error - Success response

get api/v2/organizations/show_many

Isolated FunctionResource Function

function get api/v2/organizations/show_many(string accept, string? ids, string? external_ids) returns OrganizationsResponse|error

Show Many Organizations

Parameters

accept string (default "application/json") -

ids string? (default ()) - A list of organization ids

external_ids string? (default ()) - A list of external ids

Return Type

OrganizationsResponse|error - Success response

put api/v2/organizations/update_many

Isolated FunctionResource Function

function put api/v2/organizations/update_many(string accept, string? ids, string? external_ids) returns JobStatusResponse|error

Update Many Organizations

Parameters

accept string (default "application/json") -

ids string? (default ()) - A list of organization ids

external_ids string? (default ()) - A list of external ids

Return Type

JobStatusResponse|error - Success response

get api/v2/problems

Isolated FunctionResource Function

function get api/v2/problems() returns ListTicketProblemsResponse|error

List Ticket Problems

Return Type

ListTicketProblemsResponse|error - Successful response

post api/v2/problems/autocomplete

Isolated FunctionResource Function

function post api/v2/problems/autocomplete(Problems_autocomplete_body payload, string accept, string? text) returns ListTicketProblemsResponse|error

Autocomplete Problems

Parameters

payload Problems_autocomplete_body -

accept string (default "application/json") -

text string? (default ()) - The text to search for

Return Type

ListTicketProblemsResponse|error - Successful response

post api/v2/push_notification_devices/destroy_many

Isolated FunctionResource Function

function post api/v2/push_notification_devices/destroy_many(PushNotificationDevicesRequest payload) returns string|error

Bulk Unregister Push Notification Devices

Parameters

payload PushNotificationDevicesRequest -

Return Type

string|error - Successful response

get api/v2/queues

Isolated FunctionResource Function

function get api/v2/queues() returns QueuesResponse|error

List queues

Return Type

QueuesResponse|error - Success response

post api/v2/queues

Isolated FunctionResource Function

function post api/v2/queues() returns QueueResponse|error

Create queue

Return Type

QueueResponse|error - Created response

get api/v2/queues/[string queue_id]

Isolated FunctionResource Function

function get api/v2/queues/[string queue_id](string accept) returns QueueResponse|error

Show Queue

Parameters

accept string (default "application/json") -

Return Type

QueueResponse|error - Success response

put api/v2/queues/[string queue_id]

Isolated FunctionResource Function

function put api/v2/queues/[string queue_id](string accept) returns QueueResponse|error

Update queue

Parameters

accept string (default "application/json") -

Return Type

QueueResponse|error - Success response

delete api/v2/queues/[string queue_id]

Isolated FunctionResource Function

function delete api/v2/queues/[string queue_id](string accept) returns error?

Delete queue

Parameters

accept string (default "application/json") -

Return Type

error? - No content response

get api/v2/queues/definitions

Isolated FunctionResource Function

function get api/v2/queues/definitions() returns DefinitionsResponse|error

List queue definitions

Return Type

DefinitionsResponse|error - Success response

get api/v2/recipient_addresses

Isolated FunctionResource Function

function get api/v2/recipient_addresses() returns SupportAddressesResponse|error

List Support Addresses

Return Type

SupportAddressesResponse|error - Success response

post api/v2/recipient_addresses

Isolated FunctionResource Function

function post api/v2/recipient_addresses() returns SupportAddressResponse|error

Create Support Address

Return Type

SupportAddressResponse|error - Created response

get api/v2/recipient_addresses/[int support_address_id]

Isolated FunctionResource Function

function get api/v2/recipient_addresses/[int support_address_id](string accept) returns SupportAddressResponse|error

Show Support Address

Parameters

accept string (default "application/json") -

Return Type

SupportAddressResponse|error - Success response

put api/v2/recipient_addresses/[int support_address_id]

Isolated FunctionResource Function

function put api/v2/recipient_addresses/[int support_address_id](string accept) returns SupportAddressResponse|error

Update Support Address

Parameters

accept string (default "application/json") -

Return Type

SupportAddressResponse|error - Success response

delete api/v2/recipient_addresses/[int support_address_id]

Isolated FunctionResource Function

function delete api/v2/recipient_addresses/[int support_address_id](string accept) returns error?

Delete Support Address

Parameters

accept string (default "application/json") -

Return Type

error? - No Content response

put api/v2/recipient_addresses/[int support_address_id]/verify

Isolated FunctionResource Function

function put api/v2/recipient_addresses/[int support_address_id]/verify(string accept) returns string|error

Verify Support Address Forwarding

Parameters

accept string (default "application/json") -

Return Type

string|error - Success response

get api/v2/relationships/definitions/[string target_type]

Isolated FunctionResource Function

function get api/v2/relationships/definitions/[string target_type](string accept, string? source_type) returns RelationshipFilterDefinitionResponse|error

Filter Definitions

Parameters

accept string (default "application/json") -

source_type string? (default ()) - The source type for which you would like to see filter definitions. The options are "zen:user", "zen:ticket", and "zen:organization"

Return Type

RelationshipFilterDefinitionResponse|error - Success response

get api/v2/requests

Isolated FunctionResource Function

function get api/v2/requests(string accept, string? sort_by, string? sort_order) returns RequestsResponse|error

List Requests

Parameters

accept string (default "application/json") -

sort_by string? (default ()) - Possible values are "updated_at", "created_at"

sort_order string? (default ()) - One of "asc", "desc". Defaults to "asc"

Return Type

RequestsResponse|error - Success response

post api/v2/requests

Isolated FunctionResource Function

function post api/v2/requests() returns RequestResponse|error

Create Request

Return Type

RequestResponse|error - Created response

get api/v2/requests/[int request_id]

Isolated FunctionResource Function

function get api/v2/requests/[int request_id](string accept) returns RequestResponse|error

Show Request

Parameters

accept string (default "application/json") -

Return Type

RequestResponse|error - Success response

put api/v2/requests/[int request_id]

Isolated FunctionResource Function

function put api/v2/requests/[int request_id](string accept) returns RequestResponse|error

Update Request

Parameters

accept string (default "application/json") -

Return Type

RequestResponse|error - Success response

get api/v2/requests/[int request_id]/comments

Isolated FunctionResource Function

function get api/v2/requests/[int request_id]/comments(string accept, string? since, string? role) returns TicketCommentsResponse|error

Listing Comments

Parameters

accept string (default "application/json") -

since string? (default ()) - Filters the comments from the given datetime

role string? (default ()) - One of "agent", "end_user". If not specified it does not filter

Return Type

TicketCommentsResponse|error - Success response

get api/v2/requests/[int request_id]/comments/[int ticket_comment_id]

Isolated FunctionResource Function

function get api/v2/requests/[int request_id]/comments/[int ticket_comment_id](string accept) returns TicketCommentResponse|error

Getting Comments

Parameters

accept string (default "application/json") -

Return Type

TicketCommentResponse|error - Success response

get api/v2/requests/search

Isolated FunctionResource Function

function get api/v2/requests/search(string accept, string? query) returns RequestsResponse|error

Search Requests

Parameters

accept string (default "application/json") -

query string? (default ()) - The syntax and matching logic for the string is detailed in the Zendesk Support search reference. See also Query basics in the Tickets API doc.

Return Type

RequestsResponse|error - Success response

get api/v2/resource_collections

Isolated FunctionResource Function

function get api/v2/resource_collections() returns ResourceCollectionsResponse|error

List Resource Collections

Return Type

ResourceCollectionsResponse|error - Success response

post api/v2/resource_collections

Isolated FunctionResource Function

function post api/v2/resource_collections() returns JobStatusResponse|error

Create Resource Collection

Return Type

JobStatusResponse|error - Success response

get api/v2/resource_collections/[int resource_collection_id]

Isolated FunctionResource Function

function get api/v2/resource_collections/[int resource_collection_id](string accept) returns ResourceCollectionResponse|error

Show Resource Collection

Parameters

accept string (default "application/json") -

Return Type

ResourceCollectionResponse|error - Success response

put api/v2/resource_collections/[int resource_collection_id]

Isolated FunctionResource Function

function put api/v2/resource_collections/[int resource_collection_id](string accept) returns JobStatusResponse|error

Update Resource Collection

Parameters

accept string (default "application/json") -

Return Type

JobStatusResponse|error - Success response

delete api/v2/resource_collections/[int resource_collection_id]

Isolated FunctionResource Function

function delete api/v2/resource_collections/[int resource_collection_id](string accept) returns JobStatusResponse|error

Delete Resource Collection

Parameters

accept string (default "application/json") -

Return Type

JobStatusResponse|error - Success response

get api/v2/routing/agents/[int user_id]/instance_values

Isolated FunctionResource Function

function get api/v2/routing/agents/[int user_id]/instance_values(string accept) returns SkillBasedRoutingAttributeValuesResponse|error

List Agent Attribute Values

Parameters

accept string (default "application/json") -

Return Type

SkillBasedRoutingAttributeValuesResponse|error - Success response

post api/v2/routing/agents/[int user_id]/instance_values

Isolated FunctionResource Function

function post api/v2/routing/agents/[int user_id]/instance_values(string accept) returns SkillBasedRoutingAttributeValuesResponse|error

Set Agent Attribute Values

Parameters

accept string (default "application/json") -

Return Type

SkillBasedRoutingAttributeValuesResponse|error - Success response

get api/v2/routing/attributes

Isolated FunctionResource Function

function get api/v2/routing/attributes() returns SkillBasedRoutingAttributesResponse|error

List Account Attributes

Return Type

SkillBasedRoutingAttributesResponse|error - Success response

post api/v2/routing/attributes

Isolated FunctionResource Function

function post api/v2/routing/attributes() returns SkillBasedRoutingAttributeResponse|error

Create Attribute

Return Type

SkillBasedRoutingAttributeResponse|error - Created response

get api/v2/routing/attributes/[string attribute_id]

Isolated FunctionResource Function

function get api/v2/routing/attributes/[string attribute_id](string accept) returns SkillBasedRoutingAttributeResponse|error

Show Attribute

Parameters

accept string (default "application/json") -

Return Type

SkillBasedRoutingAttributeResponse|error - Success response

put api/v2/routing/attributes/[string attribute_id]

Isolated FunctionResource Function

function put api/v2/routing/attributes/[string attribute_id](string accept) returns SkillBasedRoutingAttributeResponse|error

Update Attribute

Parameters

accept string (default "application/json") -

Return Type

SkillBasedRoutingAttributeResponse|error - Success response

delete api/v2/routing/attributes/[string attribute_id]

Isolated FunctionResource Function

function delete api/v2/routing/attributes/[string attribute_id](string accept) returns error?

Delete Attribute

Parameters

accept string (default "application/json") -

Return Type

error? - No Content response

get api/v2/routing/attributes/[string attribute_id]/values

Isolated FunctionResource Function

function get api/v2/routing/attributes/[string attribute_id]/values(string accept) returns SkillBasedRoutingAttributeValuesResponse|error

List Attribute Values for an Attribute

Parameters

accept string (default "application/json") -

Return Type

SkillBasedRoutingAttributeValuesResponse|error - Success response

post api/v2/routing/attributes/[string attribute_id]/values

Isolated FunctionResource Function

function post api/v2/routing/attributes/[string attribute_id]/values(string accept) returns SkillBasedRoutingAttributeValueResponse|error

Create Attribute Value

Parameters

accept string (default "application/json") -

Return Type

SkillBasedRoutingAttributeValueResponse|error - Created response

get api/v2/routing/attributes/[string attribute_id]/values/[string attribute_value_id]

Isolated FunctionResource Function

function get api/v2/routing/attributes/[string attribute_id]/values/[string attribute_value_id](string accept) returns SkillBasedRoutingAttributeValueResponse|error

Show Attribute Value

Parameters

accept string (default "application/json") -

Return Type

SkillBasedRoutingAttributeValueResponse|error - Success response

delete api/v2/routing/attributes/[string attribute_id]/values/[string attribute_value_id]

Isolated FunctionResource Function

function delete api/v2/routing/attributes/[string attribute_id]/values/[string attribute_value_id](string accept) returns error?

Delete Attribute Value

Parameters

accept string (default "application/json") -

Return Type

error? - No Content response

patch api/v2/routing/attributes/[string attribute_id]/values/[string attribute_value_id]

Isolated FunctionResource Function

function patch api/v2/routing/attributes/[string attribute_id]/values/[string attribute_value_id](string accept) returns SkillBasedRoutingAttributeValueResponse|error

Update Attribute Value

Parameters

accept string (default "application/json") -

Return Type

SkillBasedRoutingAttributeValueResponse|error - Success response

get api/v2/routing/attributes/definitions

Isolated FunctionResource Function

function get api/v2/routing/attributes/definitions() returns SkillBasedRoutingAttributeDefinitions|error

List Routing Attribute Definitions

Return Type

SkillBasedRoutingAttributeDefinitions|error - Success response

get api/v2/routing/requirements/fulfilled

Isolated FunctionResource Function

function get api/v2/routing/requirements/fulfilled(int ticket_ids, string accept) returns SkillBasedRoutingTicketFulfilledResponse|error

List Tickets Fulfilled by a User

Parameters

ticket_ids int - The IDs of the relevant tickets to check for matching attributes

accept string (default "application/json") -

Return Type

SkillBasedRoutingTicketFulfilledResponse|error - Success response

get api/v2/routing/tickets/[int ticket_id]/instance_values

Isolated FunctionResource Function

function get api/v2/routing/tickets/[int ticket_id]/instance_values(string accept) returns SkillBasedRoutingAttributeValuesResponse|error

List Ticket Attribute Values

Parameters

accept string (default "application/json") -

Return Type

SkillBasedRoutingAttributeValuesResponse|error - Success response

post api/v2/routing/tickets/[int ticket_id]/instance_values

Isolated FunctionResource Function

function post api/v2/routing/tickets/[int ticket_id]/instance_values(string accept) returns SkillBasedRoutingAttributeValuesResponse|error

Set Ticket Attribute Values

Parameters

accept string (default "application/json") -

Return Type

SkillBasedRoutingAttributeValuesResponse|error - Success response

get api/v2/satisfaction_ratings

Isolated FunctionResource Function

function get api/v2/satisfaction_ratings(string accept) returns SatisfactionRatingsResponse|error

List Satisfaction Ratings

Parameters

accept string (default "application/json") -

Return Type

SatisfactionRatingsResponse|error - Success response

get api/v2/satisfaction_ratings/[int satisfaction_rating_id]

Isolated FunctionResource Function

function get api/v2/satisfaction_ratings/[int satisfaction_rating_id](string accept) returns SatisfactionRatingResponse|error

Show Satisfaction Rating

Parameters

accept string (default "application/json") -

Return Type

SatisfactionRatingResponse|error - Success response

get api/v2/satisfaction_ratings/count

Isolated FunctionResource Function

function get api/v2/satisfaction_ratings/count() returns SatisfactionRatingsCountResponse|error

Count Satisfaction Ratings

Return Type

SatisfactionRatingsCountResponse|error - Count of satisfaction ratings

get api/v2/satisfaction_reasons

Isolated FunctionResource Function

function get api/v2/satisfaction_reasons() returns SatisfactionReasonsResponse|error

List Reasons for Satisfaction Rating

Return Type

SatisfactionReasonsResponse|error - Success response

get api/v2/satisfaction_reasons/[int satisfaction_reason_id]

Isolated FunctionResource Function

function get api/v2/satisfaction_reasons/[int satisfaction_reason_id](string accept) returns SatisfactionReasonResponse|error

Show Reason for Satisfaction Rating

Parameters

accept string (default "application/json") -

Return Type

SatisfactionReasonResponse|error - Success response

get api/v2/search

Isolated FunctionResource Function

function get api/v2/search(string query, string accept, string? sort_by, string? sort_order) returns SearchResponse|error

List Search Results

Parameters

query string - The search query. See Query basics above. For details on the query syntax, see the Zendesk Support search reference

accept string (default "application/json") -

sort_by string? (default ()) - One of updated_at, created_at, priority, status, or ticket_type. Defaults to sorting by relevance

sort_order string? (default ()) - One of asc or desc. Defaults to desc

Return Type

SearchResponse|error - Success response

get api/v2/search/count

Isolated FunctionResource Function

function get api/v2/search/count(string query, string accept) returns SearchCountResponse|error

Show Results Count

Parameters

query string - The search query

accept string (default "application/json") -

Return Type

SearchCountResponse|error - Success response

get api/v2/search/export

Isolated FunctionResource Function

function get api/v2/search/export(string query, string accept, int? pageSize, string? filterType) returns SearchExportResponse|error

Export Search Results

Parameters

query string - The search query. See Query basics above. For details on the query syntax, see the Zendesk Support search reference

accept string (default "application/json") -

pageSize int? (default ()) - The number of results shown in a page.

filterType string? (default ()) - The object type returned by the export query. Can be ticket, organization, user, or group.

Return Type

SearchExportResponse|error - Success response

get api/v2/sessions

Isolated FunctionResource Function

function get api/v2/sessions(string accept) returns SessionsResponse|error

List Sessions

Parameters

accept string (default "application/json") -

Return Type

SessionsResponse|error - Success response

get api/v2/sharing_agreements

Isolated FunctionResource Function

function get api/v2/sharing_agreements() returns SharingAgreementsResponse|error

List Sharing Agreements

Return Type

SharingAgreementsResponse|error - Success response

post api/v2/sharing_agreements

Isolated FunctionResource Function

function post api/v2/sharing_agreements() returns SharingAgreementResponse|error

Create Sharing Agreement

Return Type

SharingAgreementResponse|error - Created response

get api/v2/sharing_agreements/[int sharing_agreement_id]

Isolated FunctionResource Function

function get api/v2/sharing_agreements/[int sharing_agreement_id](string accept) returns SharingAgreementResponse|error

Show a Sharing Agreement

Parameters

accept string (default "application/json") -

Return Type

SharingAgreementResponse|error - Success response

put api/v2/sharing_agreements/[int sharing_agreement_id]

Isolated FunctionResource Function

function put api/v2/sharing_agreements/[int sharing_agreement_id](string accept) returns SharingAgreementResponse|error

Update a Sharing Agreement

Parameters

accept string (default "application/json") -

Return Type

SharingAgreementResponse|error - Success response

delete api/v2/sharing_agreements/[int sharing_agreement_id]

Isolated FunctionResource Function

function delete api/v2/sharing_agreements/[int sharing_agreement_id](string accept) returns error?

Delete a Sharing Agreement

Parameters

accept string (default "application/json") -

Return Type

error? - No Content response

post api/v2/skips

Isolated FunctionResource Function

function post api/v2/skips() returns TicketSkipCreation|error

Record a New Skip for the Current User

Return Type

TicketSkipCreation|error - Success response

get api/v2/slas/policies

Isolated FunctionResource Function

function get api/v2/slas/policies() returns SLAPoliciesResponse|error

List SLA Policies

Return Type

SLAPoliciesResponse|error - Success response

post api/v2/slas/policies

Isolated FunctionResource Function

function post api/v2/slas/policies() returns SLAPolicyResponse|error

Create SLA Policy

Return Type

SLAPolicyResponse|error - Created response

get api/v2/slas/policies/[int sla_policy_id]

Isolated FunctionResource Function

function get api/v2/slas/policies/[int sla_policy_id](string accept) returns SLAPolicyResponse|error

Show SLA Policy

Parameters

accept string (default "application/json") -

Return Type

SLAPolicyResponse|error - Success response

put api/v2/slas/policies/[int sla_policy_id]

Isolated FunctionResource Function

function put api/v2/slas/policies/[int sla_policy_id](string accept) returns SLAPolicyResponse|error

Update SLA Policy

Parameters

accept string (default "application/json") -

Return Type

SLAPolicyResponse|error - Success response

delete api/v2/slas/policies/[int sla_policy_id]

Isolated FunctionResource Function

function delete api/v2/slas/policies/[int sla_policy_id](string accept) returns error?

Delete SLA Policy

Parameters

accept string (default "application/json") -

Return Type

error? - No Content response

get api/v2/slas/policies/definitions

Isolated FunctionResource Function

function get api/v2/slas/policies/definitions() returns SLAPolicyFilterDefinitionResponse|error

Retrieve Supported Filter Definition Items

Return Type

SLAPolicyFilterDefinitionResponse|error - Success response

put api/v2/slas/policies/reorder

Isolated FunctionResource Function

function put api/v2/slas/policies/reorder(string accept, int[]? sla_policy_ids) returns string|error

Reorder SLA Policies

Parameters

accept string (default "application/json") -

sla_policy_ids int[]? (default ()) - The IDs of the SLA Policies to reorder

Return Type

string|error - Success response

get api/v2/suspended_tickets

Isolated FunctionResource Function

function get api/v2/suspended_tickets(string accept, string? sort_by, string? sort_order) returns SuspendedTicketsResponse|error

List Suspended Tickets

Parameters

accept string (default "application/json") -

sort_by string? (default ()) - The field to sort the ticket by, being one of author_email, cause, created_at, or subject.

sort_order string? (default ()) - The order in which to sort the suspended tickets. This can take value asc or desc.

Return Type

SuspendedTicketsResponse|error - Success response

get api/v2/suspended_tickets/[decimal id]

Isolated FunctionResource Function

function get api/v2/suspended_tickets/[decimal id](string accept) returns SuspendedTicketsResponse|error

Show Suspended Ticket

Parameters

accept string (default "application/json") -

Return Type

SuspendedTicketsResponse|error - Success response

delete api/v2/suspended_tickets/[decimal id]

Isolated FunctionResource Function

function delete api/v2/suspended_tickets/[decimal id](string accept) returns error?

Delete Suspended Ticket

Parameters

accept string (default "application/json") -

Return Type

error? - No Content response

put api/v2/suspended_tickets/[decimal id]/recover

Isolated FunctionResource Function

function put api/v2/suspended_tickets/[decimal id]/recover(string accept) returns RecoverSuspendedTicketResponse|error

Recover Suspended Ticket

Parameters

accept string (default "application/json") -

Return Type

RecoverSuspendedTicketResponse|error - Success response

post api/v2/suspended_tickets/attachments

Isolated FunctionResource Function

function post api/v2/suspended_tickets/attachments(string accept) returns SuspendedTicketsAttachmentsResponse|error

Suspended Ticket Attachments

Parameters

accept string (default "application/json") -

Return Type

SuspendedTicketsAttachmentsResponse|error - Success response

delete api/v2/suspended_tickets/destroy_many

Isolated FunctionResource Function

function delete api/v2/suspended_tickets/destroy_many(string ids, string accept) returns error?

Delete Multiple Suspended Tickets

Parameters

ids string - A comma separated list of ids of suspended tickets to delete.

accept string (default "application/json") -

Return Type

error? - No Content response

post api/v2/suspended_tickets/export

Isolated FunctionResource Function

function post api/v2/suspended_tickets/export() returns SuspendedTicketsExportResponse|error

Export Suspended Tickets

Return Type

SuspendedTicketsExportResponse|error - Ok

put api/v2/suspended_tickets/recover_many

Isolated FunctionResource Function

function put api/v2/suspended_tickets/recover_many(string ids, string accept) returns RecoverSuspendedTicketsResponse|error

Recover Multiple Suspended Tickets

Parameters

ids string - A comma separated list of ids of suspended tickets to recover.

accept string (default "application/json") -

Return Type

RecoverSuspendedTicketsResponse|error - Success response

get api/v2/tags

Isolated FunctionResource Function

function get api/v2/tags() returns TagsResponse|error

List Tags

Return Type

TagsResponse|error - Success response

get api/v2/tags/count

Isolated FunctionResource Function

function get api/v2/tags/count() returns TagCountResponse|error

Count Tags

Return Type

TagCountResponse|error - Success response

get api/v2/target_failures

Isolated FunctionResource Function

function get api/v2/target_failures() returns TargetFailuresResponse|error

List Target Failures

Return Type

TargetFailuresResponse|error - Success response

get api/v2/target_failures/[int target_failure_id]

Isolated FunctionResource Function

function get api/v2/target_failures/[int target_failure_id](string accept) returns TargetFailureResponse|error

Show Target Failure

Parameters

accept string (default "application/json") -

Return Type

TargetFailureResponse|error - Success response

get api/v2/targets

Isolated FunctionResource Function

function get api/v2/targets() returns TargetsResponse|error

List Targets

Return Type

TargetsResponse|error - Success response

post api/v2/targets

Isolated FunctionResource Function

function post api/v2/targets() returns TargetResponse|error

Create Target

Return Type

TargetResponse|error - Created response

get api/v2/targets/[int target_id]

Isolated FunctionResource Function

function get api/v2/targets/[int target_id](string accept) returns TargetResponse|error

Show Target

Parameters

accept string (default "application/json") -

Return Type

TargetResponse|error - Success response

put api/v2/targets/[int target_id]

Isolated FunctionResource Function

function put api/v2/targets/[int target_id](string accept) returns TargetResponse|error

Update Target

Parameters

accept string (default "application/json") -

Return Type

TargetResponse|error - Success response

delete api/v2/targets/[int target_id]

Isolated FunctionResource Function

function delete api/v2/targets/[int target_id](string accept) returns error?

Delete Target

Parameters

accept string (default "application/json") -

Return Type

error? - No Content response

get api/v2/ticket_audits

Isolated FunctionResource Function

function get api/v2/ticket_audits(string accept, int? 'limit) returns TicketAuditsResponse|error

List All Ticket Audits

Parameters

accept string (default "application/json") -

'limit int? (default ()) - Maximum number of results returned

Return Type

TicketAuditsResponse|error - Success response

get api/v2/ticket_fields

Isolated FunctionResource Function

function get api/v2/ticket_fields(string accept, string? locale, boolean? creator) returns TicketFieldsResponse|error

List Ticket Fields

Parameters

accept string (default "application/json") -

locale string? (default ()) - Forces the title_in_portal property to return a dynamic content variant for the specified locale. Only accepts active locale ids. Example: locale="de".

creator boolean? (default ()) - Displays the creator_user_id and creator_app_name properties. If the ticket field is created by an app, creator_app_name is the name of the app and creator_user_id is -1. If the ticket field is not created by an app, creator_app_name is null

Return Type

TicketFieldsResponse|error - Success response

post api/v2/ticket_fields

Isolated FunctionResource Function

function post api/v2/ticket_fields() returns TicketFieldResponse|error

Create Ticket Field

Return Type

TicketFieldResponse|error - Created response

get api/v2/ticket_fields/[int ticket_field_id]

Isolated FunctionResource Function

function get api/v2/ticket_fields/[int ticket_field_id](string accept, boolean? creator) returns TicketFieldResponse|error

Show Ticket Field

Parameters

accept string (default "application/json") -

creator boolean? (default ()) - If true, displays the creator_user_id and creator_app_name properties. If the ticket field is created by an app, creator_app_name is the name of the app and creator_user_id is -1. If the ticket field is not created by an app, then creator_app_name is null

Return Type

TicketFieldResponse|error - Success response

put api/v2/ticket_fields/[int ticket_field_id]

Isolated FunctionResource Function

function put api/v2/ticket_fields/[int ticket_field_id](string accept, boolean? creator) returns TicketFieldResponse|error

Update Ticket Field

Parameters

accept string (default "application/json") -

creator boolean? (default ()) - If true, displays the creator_user_id and creator_app_name properties. If the ticket field is created by an app, creator_app_name is the name of the app and creator_user_id is -1. If the ticket field is not created by an app, then creator_app_name is null

Return Type

TicketFieldResponse|error - Success response

delete api/v2/ticket_fields/[int ticket_field_id]

Isolated FunctionResource Function

function delete api/v2/ticket_fields/[int ticket_field_id](string accept, boolean? creator) returns error?

Delete Ticket Field

Parameters

accept string (default "application/json") -

creator boolean? (default ()) - If true, displays the creator_user_id and creator_app_name properties. If the ticket field is created by an app, creator_app_name is the name of the app and creator_user_id is -1. If the ticket field is not created by an app, then creator_app_name is null

Return Type

error? - No Content response

get api/v2/ticket_fields/[int ticket_field_id]/options

Isolated FunctionResource Function

function get api/v2/ticket_fields/[int ticket_field_id]/options(string accept) returns CustomFieldOptionsResponse|error

List Ticket Field Options

Parameters

accept string (default "application/json") -

Return Type

CustomFieldOptionsResponse|error - Success response

post api/v2/ticket_fields/[int ticket_field_id]/options

Isolated FunctionResource Function

function post api/v2/ticket_fields/[int ticket_field_id]/options(string accept) returns CustomFieldOptionResponse|error

Create or Update Ticket Field Option

Parameters

accept string (default "application/json") -

Return Type

CustomFieldOptionResponse|error - Success response

get api/v2/ticket_fields/[int ticket_field_id]/options/[int ticket_field_option_id]

Isolated FunctionResource Function

function get api/v2/ticket_fields/[int ticket_field_id]/options/[int ticket_field_option_id](string accept) returns CustomFieldOptionResponse|error

Show Ticket Field Option

Parameters

accept string (default "application/json") -

Return Type

CustomFieldOptionResponse|error - Success response

delete api/v2/ticket_fields/[int ticket_field_id]/options/[int ticket_field_option_id]

Isolated FunctionResource Function

function delete api/v2/ticket_fields/[int ticket_field_id]/options/[int ticket_field_option_id](string accept) returns error?

Delete Ticket Field Option

Parameters

accept string (default "application/json") -

Return Type

error? - No Content response

get api/v2/ticket_fields/count

Isolated FunctionResource Function

function get api/v2/ticket_fields/count() returns TicketFieldCountResponse|error

Count Ticket Fields

Return Type

TicketFieldCountResponse|error - Count of ticket fields

get api/v2/ticket_forms

Isolated FunctionResource Function

function get api/v2/ticket_forms(string accept, boolean? active, boolean? end_user_visible, boolean? fallback_to_default, boolean? associated_to_brand) returns TicketFormsResponse|error

List Ticket Forms

Parameters

accept string (default "application/json") -

active boolean? (default ()) - true returns active ticket forms; false returns inactive ticket forms. If not present, returns both

end_user_visible boolean? (default ()) - true returns ticket forms where end_user_visible; false returns ticket forms that are not end-user visible. If not present, returns both

fallback_to_default boolean? (default ()) - true returns the default ticket form when the criteria defined by the parameters results in a set without active and end-user visible ticket forms

associated_to_brand boolean? (default ()) - true returns the ticket forms of the brand specified by the url's subdomain

Return Type

TicketFormsResponse|error - Success response

post api/v2/ticket_forms

Isolated FunctionResource Function

function post api/v2/ticket_forms() returns TicketFormResponse|error

Create Ticket Form

Return Type

TicketFormResponse|error - Created response

get api/v2/ticket_forms/[int ticket_form_id]

Isolated FunctionResource Function

function get api/v2/ticket_forms/[int ticket_form_id](string accept) returns TicketFormResponse|error

Show Ticket Form

Parameters

accept string (default "application/json") -

Return Type

TicketFormResponse|error - Success response

put api/v2/ticket_forms/[int ticket_form_id]

Isolated FunctionResource Function

function put api/v2/ticket_forms/[int ticket_form_id](string accept) returns TicketFormResponse|error

Update Ticket Form

Parameters

accept string (default "application/json") -

Return Type

TicketFormResponse|error - Success response

delete api/v2/ticket_forms/[int ticket_form_id]

Isolated FunctionResource Function

function delete api/v2/ticket_forms/[int ticket_form_id](string accept) returns error?

Delete Ticket Form

Parameters

accept string (default "application/json") -

Return Type

error? - No Content response

post api/v2/ticket_forms/[int ticket_form_id]/clone

Isolated FunctionResource Function

function post api/v2/ticket_forms/[int ticket_form_id]/clone(string accept) returns TicketFormResponse|error

Clone an Already Existing Ticket Form

Parameters

accept string (default "application/json") -

Return Type

TicketFormResponse|error - Success response

put api/v2/ticket_forms/reorder

Isolated FunctionResource Function

function put api/v2/ticket_forms/reorder() returns TicketFormsResponse|error

Reorder Ticket Forms

Return Type

TicketFormsResponse|error - Success response

get api/v2/ticket_forms/show_many

Isolated FunctionResource Function

function get api/v2/ticket_forms/show_many(string ids, string accept, boolean? active, boolean? end_user_visible, boolean? fallback_to_default, boolean? associated_to_brand) returns TicketFormsResponse|error

Show Many Ticket Forms

Parameters

ids string - IDs of the ticket forms to be shown

accept string (default "application/json") -

active boolean? (default ()) - true returns active ticket forms; false returns inactive ticket forms. If not present, returns both

end_user_visible boolean? (default ()) - true returns ticket forms where end_user_visible; false returns ticket forms that are not end-user visible. If not present, returns both

fallback_to_default boolean? (default ()) - true returns the default ticket form when the criteria defined by the parameters results in a set without active and end-user visible ticket forms

associated_to_brand boolean? (default ()) - true returns the ticket forms of the brand specified by the url's subdomain

Return Type

TicketFormsResponse|error - Success response

get api/v2/ticket_metrics

Isolated FunctionResource Function

function get api/v2/ticket_metrics() returns TicketMetricsResponse|error

List Ticket Metrics

Return Type

TicketMetricsResponse|error - Success response

get api/v2/ticket_metrics/[string ticket_metric_id]

Isolated FunctionResource Function

function get api/v2/ticket_metrics/[string ticket_metric_id](string accept) returns TicketMetricsByTicketMetricIdResponse|error

Show Ticket Metrics

Parameters

accept string (default "application/json") -

Return Type

TicketMetricsByTicketMetricIdResponse|error - Success response

get api/v2/tickets

Isolated FunctionResource Function

function get api/v2/tickets(string accept, string? external_id) returns TicketsResponse|error

List Tickets

Parameters

accept string (default "application/json") -

external_id string? (default ()) - Lists tickets by external id. External ids don't have to be unique for each ticket. As a result, the request may return multiple tickets with the same external id.

Return Type

TicketsResponse|error - List tickets

post api/v2/tickets

Isolated FunctionResource Function

function post api/v2/tickets(TicketCreateRequest payload) returns TicketResponse|error

Create Ticket

Parameters

payload TicketCreateRequest -

Return Type

TicketResponse|error - Create ticket

get api/v2/tickets/[int ticket_id]

Isolated FunctionResource Function

function get api/v2/tickets/[int ticket_id](string accept) returns TicketResponse|error

Show Ticket

Parameters

accept string (default "application/json") -

Return Type

TicketResponse|error - Ticket

put api/v2/tickets/[int ticket_id]

Isolated FunctionResource Function

function put api/v2/tickets/[int ticket_id](TicketUpdateRequest payload, string accept) returns TicketUpdateResponse|error

Update Ticket

Parameters

payload TicketUpdateRequest -

accept string (default "application/json") -

Return Type

TicketUpdateResponse|error - Successful request

delete api/v2/tickets/[int ticket_id]

Isolated FunctionResource Function

function delete api/v2/tickets/[int ticket_id](string accept) returns error?

Delete Ticket

Parameters

accept string (default "application/json") -

Return Type

error? - No content

get api/v2/tickets/[int ticket_id]/audits

Isolated FunctionResource Function

function get api/v2/tickets/[int ticket_id]/audits(string accept) returns TicketAuditsResponseNoneCursor|error

List Audits for a Ticket

Parameters

accept string (default "application/json") -

Return Type

TicketAuditsResponseNoneCursor|error - OK response

get api/v2/tickets/[int ticket_id]/audits/[int ticket_audit_id]

Isolated FunctionResource Function

function get api/v2/tickets/[int ticket_id]/audits/[int ticket_audit_id](string accept) returns TicketAuditResponse|error

Show Audit

Parameters

accept string (default "application/json") -

Return Type

TicketAuditResponse|error - OK response

put api/v2/tickets/[int ticket_id]/audits/[int ticket_audit_id]/make_private

Isolated FunctionResource Function

function put api/v2/tickets/[int ticket_id]/audits/[int ticket_audit_id]/make_private(string accept) returns string|error

Change a Comment From Public To Private

Parameters

accept string (default "application/json") -

Return Type

string|error - description

get api/v2/tickets/[int ticket_id]/audits/count

Isolated FunctionResource Function

function get api/v2/tickets/[int ticket_id]/audits/count(string accept) returns TicketAuditsCountResponse|error

Count Audits for a Ticket

Parameters

accept string (default "application/json") -

Return Type

TicketAuditsCountResponse|error - Count of audits on a ticket

get api/v2/tickets/[int ticket_id]/collaborators

Isolated FunctionResource Function

function get api/v2/tickets/[int ticket_id]/collaborators(string accept) returns ListTicketCollaboratorsResponse|error

List Collaborators for a Ticket

Parameters

accept string (default "application/json") -

Return Type

ListTicketCollaboratorsResponse|error - Successful response

get api/v2/tickets/[int ticket_id]/comments

Isolated FunctionResource Function

function get api/v2/tickets/[int ticket_id]/comments(string accept, boolean? include_inline_images, string? include) returns TicketCommentsResponse|error

List Comments

Parameters

accept string (default "application/json") -

include_inline_images boolean? (default ()) - Default is false. When true, inline images are also listed as attachments in the response

include string? (default ()) - Accepts "users". Use this parameter to list email CCs by side-loading users. Example: ?include=users. Note: If the comment source is email, a deleted user will be represented as the CCd email address. If the comment source is anything else, a deleted user will be represented as the user name.

Return Type

TicketCommentsResponse|error - Success response

put api/v2/tickets/[int ticket_id]/comments/[int comment_id]/attachments/[int attachment_id]/redact

Isolated FunctionResource Function

function put api/v2/tickets/[int ticket_id]/comments/[int comment_id]/attachments/[int attachment_id]/redact(string accept) returns AttachmentResponse|error

Redact Comment Attachment

Parameters

accept string (default "application/json") -

Return Type

AttachmentResponse|error - OK response

put api/v2/tickets/[int ticket_id]/comments/[int ticket_comment_id]/make_private

Isolated FunctionResource Function

function put api/v2/tickets/[int ticket_id]/comments/[int ticket_comment_id]/make_private(string accept) returns string|error

Make Comment Private

Parameters

accept string (default "application/json") -

Return Type

string|error - description

put api/v2/tickets/[int ticket_id]/comments/[int ticket_comment_id]/redact

Isolated FunctionResource Function

function put api/v2/tickets/[int ticket_id]/comments/[int ticket_comment_id]/redact(string accept) returns TicketCommentResponse|error

Redact String in Comment

Parameters

accept string (default "application/json") -

Return Type

TicketCommentResponse|error - Success response

get api/v2/tickets/[int ticket_id]/comments/count

Isolated FunctionResource Function

function get api/v2/tickets/[int ticket_id]/comments/count(string accept) returns TicketCommentsCountResponse|error

Count Ticket Comments

Parameters

accept string (default "application/json") -

Return Type

TicketCommentsCountResponse|error - Count of ticket comments

get api/v2/tickets/[int ticket_id]/email_ccs

Isolated FunctionResource Function

function get api/v2/tickets/[int ticket_id]/email_ccs(string accept) returns ListTicketEmailCCsResponse|error

List Email CCs for a Ticket

Parameters

accept string (default "application/json") -

Return Type

ListTicketEmailCCsResponse|error - Successful response

get api/v2/tickets/[int ticket_id]/followers

Isolated FunctionResource Function

function get api/v2/tickets/[int ticket_id]/followers(string accept) returns ListTicketFollowersResponse|error

List Followers for a Ticket

Parameters

accept string (default "application/json") -

Return Type

ListTicketFollowersResponse|error - Successful response

get api/v2/tickets/[int ticket_id]/incidents

Isolated FunctionResource Function

function get api/v2/tickets/[int ticket_id]/incidents(string accept) returns ListTicketIncidentsResponse|error

List Ticket Incidents

Parameters

accept string (default "application/json") -

Return Type

ListTicketIncidentsResponse|error - Successful response

get api/v2/tickets/[int ticket_id]/macros/[int macro_id]/apply

Isolated FunctionResource Function

function get api/v2/tickets/[int ticket_id]/macros/[int macro_id]/apply(string accept) returns MacroApplyTicketResponse|error

Show Ticket After Changes

Parameters

accept string (default "application/json") -

Return Type

MacroApplyTicketResponse|error - Success Response

put api/v2/tickets/[int ticket_id]/mark_as_spam

Isolated FunctionResource Function

function put api/v2/tickets/[int ticket_id]/mark_as_spam(string accept) returns string|error

Mark Ticket as Spam and Suspend Requester

Parameters

accept string (default "application/json") -

Return Type

string|error - Successful response

post api/v2/tickets/[int ticket_id]/merge

Isolated FunctionResource Function

function post api/v2/tickets/[int ticket_id]/merge(TicketMergeInput payload, string accept) returns JobStatusResponse|error

Merge Tickets into Target Ticket

Parameters

payload TicketMergeInput -

accept string (default "application/json") -

Return Type

JobStatusResponse|error - Successful response

Isolated FunctionResource Function

function get api/v2/tickets/[int ticket_id]/related(string accept) returns TicketRelatedInformation|error

Ticket Related Information

Parameters

accept string (default "application/json") -

Return Type

TicketRelatedInformation|error - Successful response

post api/v2/tickets/[int ticket_id]/satisfaction_rating

Isolated FunctionResource Function

function post api/v2/tickets/[int ticket_id]/satisfaction_rating(string accept) returns SatisfactionRatingResponse|error

Create a Satisfaction Rating

Parameters

accept string (default "application/json") -

Return Type

SatisfactionRatingResponse|error - Success response

get api/v2/tickets/[int ticket_id]/tags

Isolated FunctionResource Function

function get api/v2/tickets/[int ticket_id]/tags(string accept) returns TagsByObjectIdResponse|error

List Resource Tags

Parameters

accept string (default "application/json") -

Return Type

TagsByObjectIdResponse|error - Success response

put api/v2/tickets/[int ticket_id]/tags

Isolated FunctionResource Function

function put api/v2/tickets/[int ticket_id]/tags(string accept) returns TagsByObjectIdResponse|error

Add Tags

Parameters

accept string (default "application/json") -

Return Type

TagsByObjectIdResponse|error - Success response

post api/v2/tickets/[int ticket_id]/tags

Isolated FunctionResource Function

function post api/v2/tickets/[int ticket_id]/tags(string accept) returns TagsByObjectIdResponse|error

Set Tags

Parameters

accept string (default "application/json") -

Return Type

TagsByObjectIdResponse|error - Created response

delete api/v2/tickets/[int ticket_id]/tags

Isolated FunctionResource Function

function delete api/v2/tickets/[int ticket_id]/tags(string accept) returns error?

Remove Tags

Parameters

accept string (default "application/json") -

Return Type

error? - No Content response

get api/v2/tickets/count

Isolated FunctionResource Function

function get api/v2/tickets/count() returns Inline_response_200_5|error

Count Tickets

Return Type

Inline_response_200_5|error - Count of tickets

post api/v2/tickets/create_many

Isolated FunctionResource Function

function post api/v2/tickets/create_many(TicketsCreateRequest payload) returns JobStatusResponse|error

Create Many Tickets

Parameters

payload TicketsCreateRequest -

Return Type

JobStatusResponse|error - Create many tickets

delete api/v2/tickets/destroy_many

Isolated FunctionResource Function

function delete api/v2/tickets/destroy_many(string ids, string accept) returns JobStatusResponse|error

Bulk Delete Tickets

Parameters

ids string - Comma-separated list of ticket ids

accept string (default "application/json") -

Return Type

JobStatusResponse|error - Successful response

put api/v2/tickets/mark_many_as_spam

Isolated FunctionResource Function

function put api/v2/tickets/mark_many_as_spam(string ids, string accept) returns JobStatusResponse|error

Bulk Mark Tickets as Spam

Parameters

ids string - Comma-separated list of ticket ids

accept string (default "application/json") -

Return Type

JobStatusResponse|error - Successful response

get api/v2/tickets/show_many

Isolated FunctionResource Function

function get api/v2/tickets/show_many(string ids, string accept) returns TicketsResponse|error

Show Multiple Tickets

Parameters

ids string - Comma-separated list of ticket ids

accept string (default "application/json") -

Return Type

TicketsResponse|error - List tickets

put api/v2/tickets/update_many

Isolated FunctionResource Function

function put api/v2/tickets/update_many(string accept, string? ids) returns JobStatusResponse|error

Update Many Tickets

Parameters

accept string (default "application/json") -

ids string? (default ()) - Comma-separated list of ticket ids

Return Type

JobStatusResponse|error - Successful response

get api/v2/trigger_categories

Isolated FunctionResource Function

function get api/v2/trigger_categories(string accept, Page? page, "position"|"-position"|"name"|"-name"|"created_at"|"-created_at"|"updated_at"|"-updated_at"? sort, "rule_counts"? include) returns Inline_response_200_6|error

List Trigger Categories

Parameters

accept string (default "application/json") -

page Page? (default ()) - Pagination parameters

sort "position"|"-position"|"name"|"-name"|"created_at"|"-created_at"|"updated_at"|"-updated_at"? (default ()) - Sort parameters

include "rule_counts"? (default ()) - Allowed sideloads

Return Type

Inline_response_200_6|error - A paged array of trigger categories

post api/v2/trigger_categories

Isolated FunctionResource Function

function post api/v2/trigger_categories(V2_trigger_categories_body payload) returns TriggerCategoryResponse|error

Create Trigger Category

Parameters

payload V2_trigger_categories_body -

Return Type

TriggerCategoryResponse|error - The created trigger category

get api/v2/trigger_categories/[string trigger_category_id]

Isolated FunctionResource Function

function get api/v2/trigger_categories/[string trigger_category_id](string accept) returns TriggerCategoryResponse|error

Show Trigger Category

Parameters

accept string (default "application/json") -

Return Type

TriggerCategoryResponse|error - The requested trigger category

delete api/v2/trigger_categories/[string trigger_category_id]

Isolated FunctionResource Function

function delete api/v2/trigger_categories/[string trigger_category_id](string accept) returns Response|error

Delete Trigger Category

Parameters

accept string (default "application/json") -

Return Type

Response|error - No content

patch api/v2/trigger_categories/[string trigger_category_id]

Isolated FunctionResource Function

function patch api/v2/trigger_categories/[string trigger_category_id](Trigger_categories_trigger_category_id_body payload, string accept) returns TriggerCategoryResponse|error

Update Trigger Category

Parameters

payload Trigger_categories_trigger_category_id_body -

accept string (default "application/json") -

Return Type

TriggerCategoryResponse|error - The updated trigger category

post api/v2/trigger_categories/jobs

Isolated FunctionResource Function

function post api/v2/trigger_categories/jobs(BatchJobRequest payload) returns BatchJobResponse|error

Create Batch Job for Trigger Categories

Parameters

payload BatchJobRequest -

Return Type

BatchJobResponse|error - The response to the batch job

get api/v2/triggers

Isolated FunctionResource Function

function get api/v2/triggers(string accept, boolean? active, string? sort, string? sort_by, string? sort_order, string? category_id) returns TriggersResponse|error

List Triggers

Parameters

accept string (default "application/json") -

active boolean? (default ()) - Filter by active triggers if true or inactive triggers if false

sort string? (default ()) - Cursor-based pagination only. Possible values are "alphabetical", "created_at", "updated_at", or "position".

sort_by string? (default ()) - Offset pagination only. Possible values are "alphabetical", "created_at", "updated_at", "usage_1h", "usage_24h", or "usage_7d". Defaults to "position"

sort_order string? (default ()) - One of "asc" or "desc". Defaults to "asc" for alphabetical and position sort, "desc" for all others

category_id string? (default ()) - Filter triggers by category ID

Return Type

TriggersResponse|error - Success response

post api/v2/triggers

Isolated FunctionResource Function

function post api/v2/triggers(TriggerWithCategoryRequest payload) returns

clients

records

unionTypes

ballerinax/zendesk Ballerina library

Overview

Setup guide

Step 1: Log in to Zendesk

Step 2: Access admin center

Step 3: Create a new connection

Step 4: Configure connection settings

Quickstart

Step 1: Import the connector

Step 2: Instantiate a new connector

Step 3: Invoke the connector operation

Create a ticket

List tickets

Examples

Clients

zendesk: Client

Constructor

get api/lotus/assignables/autocomplete.json

Parameters

Return Type

get api/lotus/assignables/groups.json

Return Type

get api/lotus/assignables/groups/[int group_id]/agents.json

Parameters

Return Type

get api/v2/[string target_type]/[int target_id]/relationship_fields/[int field_id]/[string source_type]

Parameters

Return Type

get api/v2/account/settings

Return Type

put api/v2/account/settings

Return Type

post api/v2/accounts

Return Type

get api/v2/accounts/available

Parameters

Return Type

get api/v2/activities

Parameters

Return Type

get api/v2/activities/[int activity_id]

Parameters

Return Type

get api/v2/activities/count

Return Type

post api/v2/any_channel/channelback/report_error

Return Type

post api/v2/any_channel/push

Return Type

post api/v2/any_channel/validate_token

Return Type

get api/v2/attachments/[int attachment_id]

Parameters

Return Type

put api/v2/attachments/[int attachment_id]

Parameters

Return Type

get api/v2/audit_logs

Parameters

Return Type

get api/v2/audit_logs/[int audit_log_id]

Parameters

Return Type

post api/v2/audit_logs/export

Parameters

Return Type

get api/v2/autocomplete/tags

Parameters

Return Type

get api/v2/automations

Return Type

post api/v2/automations

Return Type

get api/v2/automations/[int automation_id]

Parameters

Return Type

put api/v2/automations/[int automation_id]