Overview
Configuration is provided for establishing connections with Zoho Desk service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Quick Start
In this task, we will show you step-by-step how to create a connection to ZohoDesk REST API using COZYROC's REST Connection Manager.
Step 1. Run "Visual Studio" under "Administrator account". Right click on Connection managers Tab and Select New Connection. In Add SSIS Connection Manager scroll down and select Connection managers for REST Connection and click Add.
Step 2. From drop-down menu Configuration select Zoho Desk. Then click New in the Token File parameter to create a new token file.
Step 3. In following up wizard specify the orgId and add the desired scopes you want to generate token for. Then Click on ** Next**.
Step 4. In following up wizard specify the either email address or mobile number. Then Click on ** Next**.
Step 5. In following up wizard specify the password associated with your email address or mobile number. Then Click on ** SIGN IN**.
Step 6. If you have setup two factor authorization or you choose to provide OTP instead of providing password in the previous step then after completing the verification process In following up wizard specify the password associated with your email address or mobile number Click on ** Accept** in the next wizard.
Step 7: Save generated access token to file. Specify token protection password. Click OK.
Step 8. Click "Test Connection" to test your connection.
Congratulations! You have now established a connection to your Zoho Desk instance.
In this guide, we will show how to read data from the Zoho Desk service resource using the COZYROC REST Source component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open "SSIS Toolbox" and drag and drop COZYROC "REST Source" component.
Step 3. Double click on the "REST Source" component and select Zoho Desk connection from the combo. Select from available Zoho Desk resources listed in the second combo below.
Optionally you can include extra parameters in the grid below if needed or for addtional data in response.
Step 4. Click on the "Columns tab" and select Zoho Desk resource columns you want to read.
Step 5. Click Preview to make sure all necessary resource columns are included.
Bravo! You have now learned how to read data from Zoho Desk service.
In this guide, we will show how to write data to the Zoho Desk service resource using the COZYROC REST Destination component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open the "SSIS Toolbox" and drag and drop COZYROC "REST Destination" component.
Step 3. Double click on the "REST Destination" component and select Zoho Desk connection from the combo. Also, select resource action and Zoho Desk resource you want to work on.
Step 4. Click on the "Mapping" tab and map the input columns for the process you are configuring.
If you want to provide input for other resource composite objects, change the input above and map the columns.
Done. You have now learned how to write data into the Zoho Desk resource.
Configuration
Base URL address: https://desk.zoho.com/api/v1.
- OAuth 2
-
The authentication uses an authorized token. The token will be refreshed with the following expression:
{{=Date.now() + (response.expires_in - 300)}}.The authentication has the following user-defined parameters:
- Scope:
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
Documentation: https://desk.zoho.com/DeskAPIDocument#OauthTokens.
Based on resource template NoLimit.
- [Read] action
-
Endpoint URL address:
/organizations.
The result is extracted from:{{=response.data}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Organizations#Organizations_Getallorganizations.
- [Read single] action
-
Endpoint URL address:
/organizations/{{=ZohoDesk.UI.OrganizationEditor.getValue(parameters)}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- organization_id: Required. Specify organization identifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#Organizations#Organizations_Getorganization.
- [Read accessible] action
-
Endpoint URL address:
/accessibleOrganizations.
The result is extracted from:{{=response.data}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Organizations#Organizations_Getaccessibleorganizations.
- [Update] action
-
Endpoint URL address:
/organizations/{{=item.id}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Organizations_Updateorganization.
- id
A key field. Data type: DT_I4
- country
Template: ShortText.
- city
Template: ShortText.
- companyName
Template: ShortText.
- description
Template: ShortText.
- edition
Template: ShortText.
- employeeCount
Data type: DT_I4
- isAdminInOrg
Data type: DT_BOOL
- faviconURL
Template: ShortText.
- portalName
Template: ShortText.
- street
Template: ShortText.
- currencyLocale
Template: ShortText.
- alias
Template: ShortText.
- state
Template: ShortText.
- fax
Template: ShortText.
- zip
Template: ShortText.
- website
Template: ShortText.
- mobile
Template: ShortText.
- currencySymbol
Template: ShortText.
- logoURL
Template: ShortText.
- customDomain
Template: ShortText.
- isDefault
Data type: DT_BOOL The value is sent to
/organizations/markDefaultaddress.- phoneNumber
Template: ShortText.
- portalURL
Template: ShortText.
- primaryContact
Template: ShortText.
- currencyCode
Template: ShortText.
- logo
Data type: DT_IMAGE The value is gathered from
/organizations/{{=item.id}}/logoaddress. The value is sent to/organizations/{{=item.id}}/logoaddress.- favicon
Data type: DT_IMAGE The value is gathered from
/organizations/{{=item.id}}/faviconaddress. The value is sent to/organizations/{{=item.id}}/faviconaddress.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/agents.
The result is extracted from:{{=response.data}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Agents#Agents_Listagents.
- [Read single] action
-
Endpoint URL address:
/agents/{{=ZohoDesk.UI.AgentEditor.getValue(parameters)}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- agent_id: Required. Specify agent identifier.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#Organizations#Organizations_Getorganization.
- [Read email] action
-
Endpoint URL address:
/agents/email/{{=parameters.email}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- email: Required. Specify email identifier.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#Organizations#Organizations_Getorganization.
- [Read information] action
-
Endpoint URL address:
/myinfo.
The result is extracted from:{{=[response]}}.The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#Agents#Agents_GetMyInformation.
-
limit:
- [Read details] action
-
Endpoint URL address:
/agentsByIds.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- agentIds: Required. Specify comma separated agents identifiers.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#Agents_GetagentdetailsbyagentId.
- [Read profile] action
-
Endpoint URL address:
/profiles/{{=parameters.profile_id}}/agents.
The result is extracted from:{{=response.agents}}.The action has the following user-defined parameters:
- profile_id: Required. Specify profile identifier.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#Profiles#Profiles_Listagentsbyprofile.
- [Read role] action
-
Endpoint URL address:
/roles/{{=parameters.role_id}}/agents.
The result is extracted from:{{=_.map( connection.execute({ url: '/roles/' + parameters.role_id + '/agents' }).associatedAgents, function(agentId) { return connection.execute({ url: '/agents/' + agentId }); } )}}.The action has the following user-defined parameters:
- role_id: Required. Specify profile identifier.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#Roles#Roles_Listagentsbyrole.
- [Read team] action
-
Endpoint URL address:
/teams/{{=parameters.team_id}}/members.
The result is extracted from:{{=response.members}}.The action has the following user-defined parameters:
- team_id: Required. Specify team identifier.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#Teams#Teams_Listdetailsofteammembers.
- [Read department] action
-
Endpoint URL address:
/departments/{{=parameters.depatment_id}}/agents.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- depatment_id: Required. Specify department identifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#Departments#Departments_Listagentsindepartment.
- [Create] action
-
Endpoint URL address:
/agents.Documentation: https://desk.zoho.com/DeskAPIDocument#Agents#Agents_Reinviteunconfirmedagents.
- [Update] action
-
Endpoint URL address:
/agents/{{=item.id}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Agents#Agents_Updateagent.
- [Delete] action
-
Endpoint URL address:
/agents/{{=item.id}}/delete.Documentation: https://desk.zoho.com/DeskAPIDocument#Agents#Agents_Deleteconfirmedagent.
The resource includes the fields from the agentT template.
- teams
A read-only field. The value is gathered from
/agents/{{=item.id}}/teamsaddress. The gathered value is processed with{{=response.teams}}expression. Field components:- An array.
-
Uses template:
teamT.
- time_entry_summation
Template: TimeSummationT. A read-only field. The value is gathered from
/agents/{{=item.id}}/timeEntrySummationaddress. The gathered value is processed with{{=response[field.name]}}expression.- photo
Data type: DT_IMAGE A read-only field. The value is gathered from
/agents/{{=item.id}}/photoaddress.- signature
Template: ActionT. The value is gathered from
/agents/{{=item.id}}/signaturesaddress. The gathered value is processed with{{=response[field.name]}}expression. The value is sent to/agents/{{=item.id}}/signaturesaddress. Field components:-
Uses template:
ShortText. - Contains the following components: id, customizedSignatures, agentId, defaultSignature, isActive.
-
Uses template:
- skills
The value is gathered from
/agents/{{=item.id}}}/skillsaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
-
Uses template:
skillT.
- action
Template: ShortText. Field components:
-
Uses template:
ActionT. - Contains the following components: activate, deactivate, reinvite, reassignment, anonymize, mapSkills.
-
Uses template:
Based on resource template NoLimit.
- [Read] action
-
Endpoint URL address:
/profiles.
The result is extracted from:{{=response.data}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Profiles#Profiles_Listprofiles.
- [Read single] action
-
Endpoint URL address:
/profiles/{{=ZohoDesk.UI.ProfileEditor.getValue(parameters)}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- profile_id: Required. Specify profile identifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#Profiles#Profiles_Getprofile.
- [Read light agent] action
-
Endpoint URL address:
/lightAgentProfile.
The result is extracted from:{{=[response]}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Profiles#Profiles_Getlightagentprofile.
- [Update] action
-
Endpoint URL address:
/profiles/{{=item.id}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Profiles#Profiles_Updateprofile.
- [Delete] action
-
Endpoint URL address:
/profiles/{{=item.id}}/delete.Documentation: https://desk.zoho.com/DeskAPIDocument#Profiles#Profiles_Deleteprofile.
- id
A key field. Template: ShortText.
- default
Data type: DT_BOOL
- permissions
Field components:
-
Uses template:
basicProfilePermissionT. - Contains the following components: crmInteg, reports, tickets, comments, social, contracts, community, products, agents, kbCategory, setup, financeInteg, accounts, timeEntry, contacts, tasks.
-
Uses template:
- name
Template: ShortText.
- description
Template: ShortText.
- transferToProfileId
Template: ShortText.
- isVisible
Data type: DT_BOOL
- type
Template: ShortText.
- agents
A read-only field. The value is gathered from
/profiles/{{=item.id}}/agentsaddress. The gathered value is processed with{{=response.agents}}expression. Field components:- An array.
-
Uses template:
agentT.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/roles.
The result is extracted from:{{=response.data}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Roles_Listroles.
- [Read single] action
-
Endpoint URL address:
/roles/{{=ZohoDesk.UI.RoleEditor.getValue(parameters)}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- role_id: Required. Specify role identifier.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#Roles#Roles_Getrole.
- [Read personal role] action
-
Endpoint URL address:
/personalRole.
The result is extracted from:{{=[response]}}.The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#Roles#Roles_Getpersonalrole.
-
limit:
- [Read filter] action
-
Endpoint URL address:
/rolesByIds.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- roleIds: Required. Specify comma separatated role identifiers.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#Roles#Roles_ListrolesbyroleIDs.
- [Create] action
-
Endpoint URL address:
/roles.Documentation: https://desk.zoho.com/DeskAPIDocument#Roles#Roles_Createrole.
- [Update] action
-
Endpoint URL address:
/roles/{{=item.id}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Roles#Roles_Updaterole.
- [Delete] action
-
Endpoint URL address:
/roles/{{=item.id}}/delete.Documentation: https://desk.zoho.com/DeskAPIDocument#Roles#Roles_Deleterole.
- id
A key field. Template: ShortText.
- isDefault
Data type: DT_BOOL
- shareDataWithPeers
Data type: DT_BOOL
- immediateSubRoles
Template: LongText. A composite field.
- name
Template: ShortText.
- description
Template: ShortText.
- reportsTo
Template: ShortText.
- transferToRoleId
Template: ShortText.
- isVisible
Data type: DT_BOOL
- agents
Template: LongText. A read-only field. The value is gathered from
/roles/{{=item.id}}/agentsaddress. The gathered value is processed with{{=response.associatedAgents}}expression. Field components:-
Uses template:
LongText. - Contains the following components: associatedAgents.
-
Uses template:
- teams
A read-only field. The value is gathered from
/roles/{{=item.id}}/teamsaddress. The gathered value is processed with{{=response.teams}}expression. Field components:- An array.
-
Uses template:
teamT.
Based on resource template NoLimit.
- [Read] action
-
Endpoint URL address:
/teams.
The result is extracted from:{{=response.teams}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Teams#Teams_Listteamsfromallassociateddepartments.
- [Read single] action
-
Endpoint URL address:
/teams/{{=ZohoDesk.UI.TeamEditor.getValue(parameters)}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- team_id: Required. Specify team identifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#Teams#Teams_Getteam.
- [Read agent] action
-
Endpoint URL address:
/agents/{{=ZohoDesk.UI.AgentEditor.getValue(parameters)}}/teams.
The result is extracted from:{{=response.teams}}.The action has the following user-defined parameters:
- agent_id: Required. Specify agent identifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#Teams#Teams_Listassociatedteamsofagent.
- [Read role] action
-
Endpoint URL address:
/roles/{{=ZohoDesk.UI.RoleEditor.getValue(parameters)}}/teams.
The result is extracted from:{{=response.teams}}.The action has the following user-defined parameters:
- role_id: Required. Specify role identifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#Teams#Teams_Listassociatedteamsforarole.
- [Read department] action
-
Endpoint URL address:
/roles/{{=ZohoDesk.UI.DeapartmentEditor.getValue(parameters)}}/teams.
The result is extracted from:{{=response.teams}}.The action has the following user-defined parameters:
- department_id: Required. Specify department identifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#Teams#Teams_Listassociatedteamsforarole.
- [Create] action
-
Endpoint URL address:
/teams.Documentation: https://desk.zoho.com/DeskAPIDocument#Teams#Teams_Createteam.
- [Update] action
-
Endpoint URL address:
/teams/{{=item.id}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Teams#Teams_Updateteam.
- [Delete] action
-
Endpoint URL address:
/teams/{{=item.id}}/delete.Documentation: https://desk.zoho.com/DeskAPIDocument#Teams#Teams_Deleteteam.
The resource includes the fields from the teamT template.
- members
A read-only field. The value is gathered from
/teams/{{=item.id}}/membersaddress. The gathered value is processed with{{=response.members}}expression. Field components:- An array.
-
Uses template:
agentT.
- associables
A read-only field. The value is gathered from
/teams/{{=item.id}}/associablesaddress. The gathered value is processed with{{=response.teams}}expression. Field components:-
Uses template:
LongText. - Contains the following components: teams.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/departments.
The result is extracted from:{{=response.data}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Departments#Departments_Listdepartments.
- [Read single] action
-
Endpoint URL address:
/departments/{{=ZohoDesk.UI.DepartmentEditor.getValue(parameters)}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- department_id: Required. Specify department identifier.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#Departments#Departments_Getdepartment.
- [Read filter] action
-
Endpoint URL address:
/departmentsByIds.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- departmentIds: Required. Specify comma separated departments identifier.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#Departments#Departments_GetdepartmentdetailsbydepartmentIDs.
- [Read check duplicates] action
-
Endpoint URL address:
/departments/checkExists.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- departmentName: Required. Specify the department name for which you want to check duplicate entries.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#Departments#Departments_Checkforduplicatedepartments.
- [Create] action
-
Endpoint URL address:
/departments.Documentation: https://desk.zoho.com/DeskAPIDocument#Departments#Departments_Adddepartment.
- [Update] action
-
Endpoint URL address:
/departments/{{=item.id}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Departments#Departments_Updatedepartment.
- id
A key field. Template: ShortText.
- isAssignToTeamEnabled
Data type: DT_BOOL
- chatStatus
Template: ShortText.
- hasLogo
Data type: DT_BOOL
- isVisibleInCustomerPortal
Data type: DT_BOOL
- isDepartmentNameExist
Data type: DT_BOOL
- creatorId
Template: ShortText.
- description
Template: ShortText.
- associatedAgentIds
Template: LongText. A composite field.
- isDefault
Data type: DT_BOOL
- isEnabled
Data type: DT_BOOL
- name
Template: ShortText.
- createdTime
Template: DateTime.
- nameInCustomerPortal
Template: ShortText.
- status
Template: ShortText.
- agentIds
Template: LongText. A composite field.
- logo
Data type: DT_IMAGE The value is gathered from
/departments/{{=item.id}}/logoaddress. The gathered value is processed with{{=response}}expression. The value is sent to/departments/{{=item.id}}/logoaddress.- agents
A read-only field. The value is gathered from
/departments/{{=item.id}}/agentsaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
-
Uses template:
agentT.
- action
Template: ShortText. Field components:
-
Uses template:
ActionT. - Contains the following components: enable, disable, associateAgents, dissociateAgents.
-
Uses template:
Based on resource template NoLimit.
- [Read] action
-
Endpoint URL address:
/channels.
The result is extracted from:{{=response.data}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Channels#Channels_Listconfiguredchannels.
- [Read single] action
-
Endpoint URL address:
/channels/{{=parameters.channel_code}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- channel_code: Required. Specify channel code.
Documentation: https://desk.zoho.com/DeskAPIDocument#Channels#Channels_GetaChannel.
- photoURL
Template: ShortText.
- code
Template: ShortText.
- appName
Template: ShortText.
- departmentId
Template: ShortText.
- name
Template: ShortText.
- externalId
Template: ShortText.
- replyConfig
Field components:
-
Uses template:
LongText. - Contains the following components: updateRecords, acceptsAttachments, contentTypes, includeQuotedMessage.
-
Uses template:
- type
Template: ShortText.
- acceptsReplies
Data type: DT_BOOL
- logo
Data type: DT_IMAGE The value is gathered from
/channels/{{=item.code}}/photoaddress. The value is sent to/channels/{{=parameters.channel_code}}/logoaddress.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/tickets.
The result is extracted from:{{=response.data}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Tickets#Tickets_Listalltickets.
- [Read search] action
-
Endpoint URL address:
/tickets/search.
The result is extracted from:{{=response.data}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Search#Search_TicketsSearchAPI.
- [Read single] action
-
Endpoint URL address:
/tickets/{{=parameters.ticket_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- ticket_id: Required. Specify ticket identifier.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#Organizations#Organizations_Getorganization.
- [Read archive] action
-
Endpoint URL address:
/tickets/archivedTickets.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- departmentId: Required. Specify department identifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#Tickets#Tickets_GetArchivedTicketList.
- [Read associated] action
-
Endpoint URL address:
/associatedTickets.
The result is extracted from:{{=response.data}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Tickets#Tickets_Listallassociatedtickets.
- [Read crm] action
-
Endpoint URL address:
/ticketsByCrmContactType.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- crmContactType: Required. Specify the crm contact type (e.g) potentials, customers or contact_leads.
Documentation: https://desk.zoho.com/DeskAPIDocument#QueueAPIs_ListticketsbyCRMType.
- [Read dueMins] action
-
Endpoint URL address:
/ticketsByDueInMinutes.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- dueInMinutes: Required. Specify the number of minutes left for resolving the ticket.
Documentation: https://desk.zoho.com/DeskAPIDocument#QueueAPIs#QueueAPIs_Listticketsbydueminutes.
- [Read status] action
-
Endpoint URL address:
/ticketsByStatus.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- status: Required. Specify the status of the ticket.
Documentation: https://desk.zoho.com/DeskAPIDocument#QueueAPIs#QueueAPIs_Listticketsbystatus.
- [Read account] action
-
Endpoint URL address:
/accounts/{{=parameters.account_id}}/tickets.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- account_id: Required. Specify the account identifier.
Documentation: https://support.zoho.com/support/APIDocument.do#Accounts#Accounts_Listticketsbyaccount.
- [Read contact] action
-
Endpoint URL address:
/contacts/{{=parameters.contact_id}}/tickets.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- contact_id: Required. Specify id contact identifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#Contacts#Contacts_Listticketsbycontact.
- [Read product] action
-
Endpoint URL address:
/products/{{=parameters.product_id}}/tickets.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- product_id: Required. Specify the product identifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#Products#Products_Listticketsbyproducts.
- [Read issue] action
-
Endpoint URL address:
/jiraIssue/{{=parameters.issue_id}/tickets.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- issue_id: Required. Specify issue dentifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#Jira#Jira_GetLinkedTicketsbyJiraIssueId.
- [Read tag] action
-
Endpoint URL address:
/tags/{{=parameters.tag_id}}/tickets.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- tag_id: Required. Specify tag identifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#TicketTags#TicketTags_Listtagsinaticket.
- [Read bug] action
-
Endpoint URL address:
/bug/{{=parameters.bug_id}}/tickets.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- bug_id: Required. Specify bug identifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#BugTracker#BugTracker_GetLinkedTicketsbyBugId.
- [Read invoice] action
-
Endpoint URL address:
/finance/invoices/{{=parameters.ticket_id}}/tickets.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- ticket_id: Required. Specify ticket identifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#Finance#Finance_Getticketsforinvoices.
- [Read sar] action
-
Endpoint URL address:
/subjectAccessRequests/entities.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- contactEmailId: Required. Specify email of contact making request.
The following request parameters will be automatically processed:
-
module:
tickets
Documentation: https://desk.zoho.com/DeskAPIDocument#SubjectAccessRequests#SubjectAccessRequests_Listresourcesrelatedtosubject.
- [Create] action
-
Endpoint URL address:
/tickets.Documentation: https://desk.zoho.com/DeskAPIDocument#Tickets#Tickets_Createaticket.
- [Update] action
-
Endpoint URL address:
/tickets/{{=item.id}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Tickets#Tickets_Updateaticket.
- [Delete] action
-
Endpoint URL address:
/tickets/moveToTrash.Documentation: https://desk.zoho.com/DeskAPIDocument#Tickets#Tickets_MoveTicketstotrash.
The resource includes the fields from the ticketT template.
- history
A read-only field. The value is gathered from
/tickets/{{=item.id}}/Historyaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
- Contains the following components: actor, eventInfo, eventTime, eventName, source, actorInfo.
- active_timers
A read-only field. The value is gathered from
/tickets/{{=item.id}}/activeTimeraddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
- Contains the following components: owner, timer, userId.
- timer
Template: timerT. The value is gathered from
/tickets/{{=item.id}}/timeraddress. The value is sent to/tickets/{{=item.id}}/timeraddress.- tags
A read-only field. The value is gathered from
/tickets/{{=item.id}}/tagsaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
- Contains the following components: id, name, tagType.
- resolution
Template: ticketResolutionT. A read-only field. The value is gathered from
/tickets/{{=item.id}}/resolutionaddress. The gathered value is processed with{{=response[field.name]}}expression.- resolution_history
A read-only field. The value is gathered from
/tickets/{{=item.id}}/resolutionHistoryaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
-
Uses template:
ticketResolutionT.
- time_entry_summation
Template: TimeSummationT. A read-only field. The value is gathered from
/tickets/{{=item.id}}/timeEntrySummationaddress. The gathered value is processed with{{=response[field.name]}}expression.- metric
A read-only field. The value is gathered from
/tickets/{{=item.id}}/([0-9]+)/metricsaddress. The gathered value is processed with{{=response[field.name]}}expression. Field components:-
Uses template:
DateTime. - Contains the following components: firstResponseTime, reassignCount, outgoingCount, threadCount, totalResponseTime, responseCount, agentsHandled, resolutionTime, stagingData, reopenCount.
-
Uses template:
- relevant_articles
A read-only field. The value is gathered from
/tickets/{{=item.id}}/articleSuggestionaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
-
Uses template:
articleT.
- tasks
A read-only field. The value is gathered from
/tickets/{{=item.id}}/tasksaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
-
Uses template:
taskT.
- activities
A read-only field. The value is gathered from
/tickets/{{=item.id}}/activitiesaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
-
Uses template:
ActivityT.
- calls
A read-only field. The value is gathered from
/tickets/{{=item.id}}/callsaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
-
Uses template:
CallT.
- events
A read-only field. The value is gathered from
/tickets/{{=item.id}}/eventsaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
-
Uses template:
EventT.
- blueprint
A read-only field. The value is gathered from
/tickets/{{=item.id}}/blueprintaddress. The gathered value is processed with{{=response[field.name]}}expression. Field components:-
Uses template:
ShortText. - Contains the following components: id, name, state, transitions.
-
Uses template:
- action
Template: ShortText. Field components:
-
Uses template:
ActionT. - Contains the following components: merge, move, split, markAsRead, revokeBlueprint, deleteBlueprintTransitionDraft.
-
Uses template:
- [External]
-
The external fields URL address:
/organizationFields. The external fields list is extracted from:{{=ZohoDesk.getCustomFields(response.data)}}.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/tickets/{{=parameters.ticket_id}}/threads.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- ticket_id: Required. Specify ticket identifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#Threads#Threads_Listallthreads.
- [Read conversation] action
-
Endpoint URL address:
/tickets/{{=parameters.ticket_id}}/conversations.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- ticket_id: Required. Specify ticket identifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#Threads#Threads_Listconversations.
- [Read latest] action
-
Endpoint URL address:
/tickets/{{=parameters.ticket_id}}/latestThread.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- ticket_id: Required. Specify ticket identifier.
- thread_id: Required. Specify thread identifier.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#Threads#Threads_GetLatestthread.
- [Read single] action
-
Endpoint URL address:
/tickets/{{=parameters.ticket_id}}/threads/{{=parameters.thread_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- ticket_id: Required. Specify ticket identifier.
- thread_id: Required. Specify thread identifier.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#Threads#Threads_Getathread.
- [Update] action
-
Endpoint URL address:
/tickets/{{=parameters.ticket_id}}/draftReply/{{=item.id}}.The action has the following user-defined parameters:
- ticket_id: Required. Specify ticket identifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#Threads#Threads_UpdateDraft.
- id
Template: ShortText.
- summary
Template: ShortText.
- isDescriptionThread
Data type: DT_BOOL
- canReply
Data type: DT_BOOL
- visibility
Template: ShortText.
- author
Template: authorT.
- channel
Template: ShortText.
- source
Template: sourceT.
- type
Template: ShortText.
- to
Template: ShortText.
- from
Template: ShortText.
- lastRatingIconURL
Template: ShortText.
- isForward
Data type: DT_BOOL
- hasAttach
Data type: DT_BOOL
- responderId
Template: ShortText.
- channelRelatedInfo
Template: channelRelatedInfoT.
- respondedIn
Template: ShortText.
- createdTime
Template: DateTime.
- attachmentCount
Template: ShortText.
- fromEmailAddress
Template: ShortText.
- actions
Template: LongText. A composite field.
- contentType
Template: ShortText.
- status
Template: ShortText.
- direction
Template: ShortText.
- attachments
Field components:
- An array.
-
Uses template:
attachmentT.
- content
Template: ShortText.
- bcc
Template: ShortText.
- plainText
Template: ShortText.
- replyTo
Template: ShortText.
- isContentTruncated
Data type: DT_BOOL
- fullContentURL
Template: ShortText.
- ticketStatus
Template: ShortText.
- attachmentIds
Template: LongText. A composite field.
- original_mail_content
A read-only field. The value is gathered from
/tickets/{{=parameters.ticket_id}}/threads/{{=item.id}}/originalContentaddress. The gathered value is processed with{{=response[field.name]}}expression. Field components:-
Uses template:
ShortText. - Contains the following components: date, returnPath, subject, messageId, from, to, content.
-
Uses template:
- action
Template: ShortText. Field components:
-
Uses template:
ActionT. - Contains the following components: sendForReview, sendReply, draftReply, deleteAttachment.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/contacts.
The result is extracted from:{{=response.data}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Contacts#Contacts_Listcontacts.
- [Read search] action
-
Endpoint URL address:
/contacts/search.
The result is extracted from:{{=response.data}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Search#Search_SearchContacts.
- [Read single] action
-
Endpoint URL address:
/contacts/{{=parameters.contact_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- contact_id: Required. Specify contact identifier.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#Contacts#Contacts_GetContact.
- [Read filter] action
-
Endpoint URL address:
/contactsByIds.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- ids: Required. Specify comma separated contacts identifiers.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#Contacts#Contacts_ListContactsByIds.
- [Read account] action
-
Endpoint URL address:
/accounts/{{=parameters.account_id}}/contacts.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- account_id: Required. Specify the account identifier.
Documentation: https://support.zoho.com/support/APIDocument.do#Accounts#Accounts_ListAssociatedcontacts.
- [Read product] action
-
Endpoint URL address:
/products/{{=parameters.product_id}}/contacts.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- product_id: Required. Specify the product identifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#Products#Products_Listcontactsassociatedwithproduct.
- [Read duplicate] action
-
Endpoint URL address:
/groupContacts.
The result is extracted from:{{=[].concat(_.flatten(_.pluck(response.data, 'contacts')))}}.The action has the following user-defined parameters:
- fieldName: Required. Specify the name of the field.
- fieldValues: Required. Specify the actual values related to the contact.
Documentation: https://desk.zoho.com/DeskAPIDocument#ContactDeduplication#ContactDeduplication_Listdetailsofduplicatecontacts.
- [Read sar] action
-
Endpoint URL address:
/subjectAccessRequests/entities.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- contactEmailId: Required. Specify email of contact making request.
The following request parameters will be automatically processed:
-
module:
contacts
Documentation: https://desk.zoho.com/DeskAPIDocument#SubjectAccessRequests#SubjectAccessRequests_Listresourcesrelatedtosubject.
- [Create] action
-
Endpoint URL address:
/contacts.Documentation: https://desk.zoho.com/DeskAPIDocument#Contacts#Contacts_CreateContact.
- [Update] action
-
Endpoint URL address:
/contacts/{{=item.id}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Contacts#Contacts_Updateacontact.
- [Delete] action
-
Endpoint URL address:
/contacts/moveToTrash.Documentation: https://desk.zoho.com/DeskAPIDocument#Contacts#Contacts_DeleteContacts.
The resource includes the fields from the contactT template.
- profiles
A read-only field. The value is gathered from
/contacts/{{=item.id}}/profilesaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
- Contains the following components: id, photoURL, displayName, name, channel, source.
- history
A read-only field. The value is gathered from
/contacts/{{=item.id}}/historyaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
-
Uses template:
historyT.
- status_help_center
A read-only field. The value is gathered from
/contacts/{{=item.id}}/helpCentersaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
- Contains the following components: helpCenter, userStatus, userId.
- statistics
Template: statisticsT. A read-only field. The value is gathered from
/contacts/{{=item.id}}/statisticsaddress. The gathered value is processed with{{=response[field.name]}}expression.- tickets
A read-only field. The value is gathered from
/contacts/{{=item.id}}/ticketsaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
-
Uses template:
ticketT.
- products
A read-only field. The value is gathered from
/contacts/{{=item.id}}/productsaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
-
Uses template:
productT.
- time_entry_summation
Template: TimeSummationT. A read-only field. The value is gathered from
/contacts/{{=item.id}}/timeEntrySummationaddress. The gathered value is processed with{{=response[field.name]}}expression.- action
Template: ShortText. Field components:
-
Uses template:
ActionT. - Contains the following components: merge, associateProducts, associateAccounts, dissociateAccounts, deletePhoto.
-
Uses template:
- [External]
-
The external fields URL address:
/organizationFields. The external fields list is extracted from:{{=ZohoDesk.getCustomFields(response.data)}}.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/accounts.
The result is extracted from:{{=response.data}}.Documentation: https://support.zoho.com/support/APIDocument.do#Accounts#Accounts_Listaccounts.
- [Read search] action
-
Endpoint URL address:
/accounts/search.
The result is extracted from:{{=response.data}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Search#Search_Searchaccounts.
- [Read single] action
-
Endpoint URL address:
/accounts/{{=parameters.account_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- account_id: Required. Specify the account identifier.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://support.zoho.com/support/APIDocument.do#Accounts#Accounts_GetAccount.
- [Read product] action
-
Endpoint URL address:
/products/{{=parameters.product_id}}/accounts.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- product_id: Required. Specify the product identifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#Products#Products_Listaccountsassociatedwithproduct.
- [Read duplicate] action
-
Endpoint URL address:
/groupAccounts.
The result is extracted from:{{=[].concat(_.flatten(_.pluck(response.data, 'accounts')))}}.The action has the following user-defined parameters:
- fieldName: Required. Specify the name of the field.
- fieldValues: Required. Specify the actual values related to the account.
Documentation: https://desk.zoho.com/DeskAPIDocument#AccountDeduplication#AccountDeduplication_Listdetailsofduplicateaccounts.
- [Create] action
-
Endpoint URL address:
/accounts.Documentation: https://desk.zoho.com/DeskAPIDocument#Accounts#Accounts_CreateAccount.
- [Update] action
-
Endpoint URL address:
/accounts/{{=item.id}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Accounts#Accounts_UpdateAccount.
- [Delete] action
-
Endpoint URL address:
/accounts/moveToTrash.Documentation: https://desk.zoho.com/DeskAPIDocument#Accounts#Accounts_DeleteAccounts.
The resource includes the fields from the accountT template.
- contracts
A read-only field. The value is gathered from
/accounts/{{=item.id}}/contractsaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
- Contains the following components: slaName, endDate, slaGroupId, departmentId, contractId, contractNumber, description, contractName, ownerId, startDate.
- history
A read-only field. The value is gathered from
/accounts/{{=item.id}}/historyaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
-
Uses template:
historyT.
- tickets
A read-only field. The value is gathered from
/accounts/{{=item.id}}/ticketsaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
-
Uses template:
ticketT.
- statistics
Template: statisticsT. A read-only field. The value is gathered from
/accounts/{{=item.id}}/statisticsaddress. The gathered value is processed with{{=response[field.name]}}expression.- products
A read-only field. The value is gathered from
/accounts/{{=item.id}}/productsaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
-
Uses template:
productT.
- SLAs
A read-only field. The value is gathered from
/accounts/{{=item.id}}/slaaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
- Contains the following components: id, slaName, isActive, department.
- time_entry_summation
Template: TimeSummationT. A read-only field. The value is gathered from
/accounts/{{=item.id}}/timeEntrySummationaddress. The gathered value is processed with{{=response[field.name]}}expression.- action
Template: ShortText. Field components:
-
Uses template:
ActionT. - Contains the following components: merge, associateProducts, associateSLA.
-
Uses template:
- [External]
-
The external fields URL address:
/organizationFields. The external fields list is extracted from:{{=ZohoDesk.getCustomFields(response.data)}}.
Based on resource template Base.
- [Update] action
-
Endpoint URL address:
/accountContactMapping/{{=item.mapping_id}}.Documentation: https://support.zoho.com/support/APIDocument.do#AccountContactMapping#AccountContactMapping_Updateassociationinfo.
- mappingType
Template: ShortText.
- isAccountTicketsViewable
Data type: DT_BOOL
- mapping_Id
A key field. Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/tasks.
The result is extracted from:{{=response.data}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Tasks#Tasks_Listtasks.
- [Read search] action
-
Endpoint URL address:
/tasks/search.
The result is extracted from:{{=response.data}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Search#Search_SearchTasks.
- [Read single] action
-
Endpoint URL address:
/tasks/{{=ZohoDesk.UI.TaskEditor.getValue(parameters)}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- task_id: Required. Specify task identifier.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#Tasks#Tasks_Gettask.
- [Read ticket] action
-
Endpoint URL address:
/tickets/{{=parameters.ticket_id}}/tasks.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- ticket_id: Required. Specify ticket identifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#Tasks#Tasks_Listtasksbyticket.
- [Create] action
-
Endpoint URL address:
/tasks.Documentation: https://desk.zoho.com/DeskAPIDocument#Tasks#Tasks_Createtask.
- [Update] action
-
Endpoint URL address:
/tasks/{{=item.id}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Tasks#Tasks_Updatetask.
- [Delete] action
-
Endpoint URL address:
/tasks/moveToTrash.Documentation: https://desk.zoho.com/DeskAPIDocument#Tasks#Tasks_Deletetasks.
The resource includes the fields from the taskT template.
- active_timers
A read-only field. The value is gathered from
/tasks/{{=item.id}}/activeTimeraddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
- Contains the following components: owner, timer, userId.
- timer
Template: timerT. The value is gathered from
/tasks/{{=item.id}}/timeraddress. The value is sent to/tasks/{{=item.id}}/timeraddress.- time_entry_summation
Template: TimeSummationT. A read-only field. The value is gathered from
/tasks/{{=item.id}}/timeEntrySummationaddress. The gathered value is processed with{{=response[field.name]}}expression.
- [External]
-
The external fields URL address:
/organizationFields. The external fields list is extracted from:{{=ZohoDesk.getCustomFields(response.data)}}.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/products.
The result is extracted from:{{=response.data}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Products#Products_Listproducts.
- [Read search] action
-
Endpoint URL address:
/products/search.
The result is extracted from:{{=response.data}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Search#Search_ProductsSearchAPI.
- [Read single] action
-
Endpoint URL address:
/products/{{=ZohoDesk.UI.ProductEditor.getValue(parameters)}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- product_id: Required. Specify product identifier.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#Tasks#Tasks_Gettask.
- [Read search duplicates] action
-
Endpoint URL address:
/products/searchDuplicates.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- productName: Required. Specify product name as a keyword for search.
Documentation: https://desk.zoho.com/DeskAPIDocument#Products#Products_Searchforduplicaterecords.
- [Read account] action
-
Endpoint URL address:
/accounts/{{=parameters.account_id}}/products.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- account_id: Required. Specify the account identifier.
Documentation: https://support.zoho.com/support/APIDocument.do#Accounts#Accounts_Listproductsbyaccount.
- [Read contact] action
-
Endpoint URL address:
/contacts/{{=parameters.contact_id}}/products.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- contact_id: Required. Specify the contact identifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#Contacts#Contacts_Listproductsbycontact.
- [Create] action
-
Endpoint URL address:
/products.Documentation: https://desk.zoho.com/DeskAPIDocument#Products#Products_Createproduct.
- [Update] action
-
Endpoint URL address:
/products/{{=item.id}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Products#Products_Updateproduct.
- [Delete] action
-
Endpoint URL address:
/products/moveToTrash.Documentation: https://desk.zoho.com/DeskAPIDocument#Products#Products_MoveProductstotrash.
The resource includes the fields from the productT template.
- tickets
A read-only field. The value is gathered from
/products/{{=item.id}}/ticketsaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
-
Uses template:
ticketT.
- accounts
A read-only field. The value is gathered from
/products/{{=item.id}}/accountsaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
-
Uses template:
accountT.
- contacts
A read-only field. The value is gathered from
/products/{{=item.id}}/contactsaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
-
Uses template:
contactT.
- action
Template: ShortText. Field components:
-
Uses template:
ActionT. - Contains the following components: associateContacts, associateAccounts.
-
Uses template:
- [External]
-
The external fields URL address:
/organizationFields. The external fields list is extracted from:{{=ZohoDesk.getCustomFields(response.data)}}.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/helpCenters.
The result is extracted from:{{=response.data}}.Documentation: https://desk.zoho.com/DeskAPIDocument#HelpCenter_Listhelpcenters.
- [Read single] action
-
Endpoint URL address:
/helpCenters/{{=parameters.helpcenter_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- helpcenter_id: Required. Specify help center identifier.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#HelpCenter#HelpCenter_Getdetailsofhelpcenter.
- [Update] action
-
Endpoint URL address:
/helpCenters/{{=item.id}}/sitemaps.Documentation: https://desk.zoho.com/DeskAPIDocument#HelpCenter#HelpCenter_UpdateHelpcentersitemaps.
- id
A key field. Template: ShortText.
- domains
Field components:
- An array.
- Contains the following components: name, type.
- logoLinkBackUrl
Template: ShortText.
- departmentIds
Template: LongText. A composite field.
- logoUrl
Template: ShortText.
- url
Template: ShortText.
- isDefault
Data type: DT_BOOL
- siteMapUpdatedTime
Template: DateTime.
- name
Template: ShortText.
- favIconUrl
Template: ShortText.
- helpCenterLocales
Field components:
- An array.
- Contains the following components: name, locale, type, status.
Field components:
- An array.
-
Uses template:
emailT.
- primaryLocale
Template: ShortText.
- status
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/users.
The result is extracted from:{{=response.data}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Users#Users_Listhelpcenterusers.
- [Read single] action
-
Endpoint URL address:
/users/{{=parameters.user_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- user_id: Required. Specify the user identifier.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#Users#Users_Getdetailsofuser.
- [Read label] action
-
Endpoint URL address:
/labels/{{=parameters.label_id}}/users.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- label_id: Required. Specify the label identifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#Labels#Labels_Listusersunderalabel.
- [Read group] action
-
Endpoint URL address:
/groups/{{=parameters.group_id}}/users.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- group_id: Required. Specify the group identifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#Groups#Groups_Listusersinagroup.
- [Update] action
-
Endpoint URL address:
/users/{{=item.id}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Users#Users_Updatedetailsofuser.
The resource includes the fields from the userT template.
- groups
A read-only field. The value is gathered from
/users/{{=item.id}}/groupsaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
-
Uses template:
groupT.
- labels
A read-only field. The value is gathered from
/users/{{=item.id}}/labelsaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
-
Uses template:
labelT.
- badges
A read-only field. The value is gathered from
/users/{{=item.id}}/badgesaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
- Contains the following components: id, name, isCustom, description, iconUrl.
- action
Template: ShortText. Field components:
-
Uses template:
ActionT. - Contains the following components: addToGroup, removeFromGroup, assignLabels, removeLabels, addBadges, removeBadges.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/labels.
The result is extracted from:{{=response.data}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Labels#Labels_Listlabels.
- [Read single] action
-
Endpoint URL address:
/labels/{{=parameters.label_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- label_id: Required. Specify the label identifier.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#Labels#Labels_Getdetailsoflabel.
- [Read user] action
-
Endpoint URL address:
/users/{{=parameters.user_id}}/labels.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- user_id: Required. Specify the user identifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#Users#Users_Listlabelsofuser.
- [Create] action
-
Endpoint URL address:
/labels.Documentation: https://desk.zoho.com/DeskAPIDocument#Labels#Labels_Createlabel.
- [Update] action
-
Endpoint URL address:
/labels/{{=item.id}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Labels#Labels_Updatelabel.
- [Delete] action
-
Endpoint URL address:
/labels/{{=item.id}}.
The action uses DELETE method.Documentation: https://desk.zoho.com/DeskAPIDocument#Labels#Labels_Deletelabel.
The resource includes the fields from the labelT template.
- users
A read-only field. The value is gathered from
/labels/{{=item.id}}/usersaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
-
Uses template:
userT.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/groups.
The result is extracted from:{{=response.data}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Groups#Groups_Listgroups.
- [Read single] action
-
Endpoint URL address:
/labels/{{=parameters.group_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- group_id: Required. Specify the group identifier.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#Groups#Groups_Getdetailsofgroup.
- [Read user] action
-
Endpoint URL address:
/users/{{=parameters.user_id}}/groups.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- user_id: Required. Specify the user identifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#Users#Users_Listusergroups.
- [Create] action
-
Endpoint URL address:
/groups.Documentation: https://desk.zoho.com/DeskAPIDocument#Groups#Groups_Createusergroups.
- [Update] action
-
Endpoint URL address:
/groups/{{=item.id}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Groups#Groups_Updategroup.
- [Delete] action
-
Endpoint URL address:
/groups/{{=item.id}}.
The action uses DELETE method.Documentation: https://desk.zoho.com/DeskAPIDocument#Groups#Groups_Deletegroup.
The resource includes the fields from the groupT template.
- users
A read-only field. The value is gathered from
/groups/{{=item.id}}/usersaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
-
Uses template:
userT.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/articles.
The result is extracted from:{{=response.data}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Articles#Articles_Listarticles.
- [Read search] action
-
Endpoint URL address:
/articles/search.
The result is extracted from:{{=response.data}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Search#Search_ArticleSearchAPI.
- [Read single] action
-
Endpoint URL address:
/articles/{{=parameters.article_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- article_id: Required. Specify article identifier.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#Articles#Articles_Getarticle.
- [Read category] action
-
Endpoint URL address:
/kbCategory/{{=parameters.category_id}}/repositionArticles.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- category_id: Required. Specify category identifier.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#Articles#Articles_Getarticlesformanualsorting.
- [Read preview] action
-
Endpoint URL address:
/articles/preview.
The result is extracted from:{{=[response]}}.
The action uses POST method.The action has the following user-defined parameters:
- JSON: Required. Specify in JSON format (e.g) { "answer": "", "title": "" }
The following request parameters will be automatically processed:
-
limit:
{{=undefined}} -
application/json:
{{=parameters.get('JSON') ? JSON.parse(parameters.JSON) : parameters}}
Documentation: https://desk.zoho.com/DeskAPIDocument#Articles#Articles_Previewarticle.
- [Read suggestion] action
-
Endpoint URL address:
/tickets/{{=item.id}}/articleSuggestion.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- article_id: Required. Specify ticket identifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#Tickets#Tickets_Suggestrelevantarticlesforticket.
- [Create] action
-
Endpoint URL address:
/articles.Documentation: https://desk.zoho.com/DeskAPIDocument#Articles#Articles_Createanarticle.
- [Update] action
-
Endpoint URL address:
/articles/{{=item.id}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Articles#Articles_Updateanarticle.
- [Delete] action
-
Endpoint URL address:
/articles/moveToTrash.Documentation: https://desk.zoho.com/DeskAPIDocument#Groups#Groups_Deletegroup.
The resource includes the fields from the articleT template.
- history
A read-only field. The value is gathered from
/articles/{{=item.id}}/historyaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
- Contains the following components: eventTime, deltedVersion, solutionId, locale, event, user.
- statistics
A read-only field. The value is gathered from
/articles/{{=item.id}}/insightsaddress. The gathered value is processed with{{=response[field.name]}}expression. Field components:-
Uses template:
DateTime. - Contains the following components: feedbackCount, lastLikedTime, dislikeCount, lastUsageTime, likeCount, attachmentCount, viewCount, lastActivityTime, lastDislikedTime, usageCount, commentCount.
-
Uses template:
- attachments
The value is gathered from
/articles/{{=item.id}}/translations/{{=item.locale}}/attachmentsaddress. Field components:- An array.
- Contains the following components: resourceId, extension, name, viewUrl, downloadUrl, createdTime, filesize, filename, content.
- feedbacks
The value is gathered from
/articles/{{=item.id}}/translations/{{=item.locale}}/feedbacksaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
-
Uses template:
ArticleFeedbackT.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/articleFeedbacks.
The result is extracted from:{{=response.data}}.Documentation: https://desk.zoho.com/DeskAPIDocument#ArticleFeedback#ArticleFeedback_Listfeedbackcomments.
- [Read article] action
-
Endpoint URL address:
/articles/{{=parameters.article_id}}/translations/{{=parameters.locale}}/feedbacks.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- article_id: Required. Specify article identifier.
- locale: Required. Specify the locale.
Documentation: https://desk.zoho.com/DeskAPIDocument#ArticleFeedback#ArticleFeedback_Listfeedbackcommentsonarticletranslation.
- [Read single] action
-
Endpoint URL address:
/articleFeedbacks/{{=parameters.feedback_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- feedback_id: Required. Specify feedback identifier.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#ArticleFeedback#ArticleFeedback_Getdetailsoffeedbackcomment.
- [Delete] action
-
Endpoint URL address:
/articleFeedbacks/{{=item.id}}.
The action uses DELETE method.Documentation: https://desk.zoho.com/DeskAPIDocument#ArticleFeedback#ArticleFeedback_Deletefeedbackcomment.
The resource includes the fields from the ArticleFeedbackT template.
- action
Template: ShortText. Field components:
- Contains the following components: addAsTicket.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/kbRootCategories.
The result is extracted from:{{=response.data}}.Documentation: https://desk.zoho.com/DeskAPIDocument#KBCategory_Listrootcategories.
- [Read single] action
-
Endpoint URL address:
/kbRootCategories/{{=ZohoDesk.UI.KBCategoryEditor.getValue(parameters)}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- rootCategory_id: Required. Specify root category identifier.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#KBCategory#KBCategory_Getrootcategory.
- [Read section] action
-
Endpoint URL address:
/kbSections/{{=parameters.section_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- section_id: Required. Specify section identifier.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#KBCategory_Getasection.
- [Create] action
-
Endpoint URL address:
{{=item.parentCategoryId ? '/kbSections' : '/kbRootCategories'}}.Documentation: https://desk.zoho.com/DeskAPIDocument#KBCategory#KBCategory_Createrootcategory https://desk.zoho.com/DeskAPIDocument#KBCategory#KBCategory_Createasection .
- [Update] action
-
Endpoint URL address:
/kbSections/{{=item.id}}.Documentation: https://desk.zoho.com/DeskAPIDocument#KBCategory#KBCategory_Updateasection.
The resource includes the fields from the kbCategoryT template.
- action
Template: ShortText. Field components:
-
Uses template:
ActionT. - Contains the following components: addPermalink, removePermalink.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/kbRootCategories/{{=parameters.rootCategory_id}}/reviewOwners.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- rootCategory_id: Required. Specify root category identifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#KBCategory#KBCategory_Getreviewowners.
- [Create] action
-
Endpoint URL address:
/kbRootCategories/{{=parameters.rootCategory_id}}/reviewOwners/add.The action has the following user-defined parameters:
- rootCategory_id: Required. Specify root category identifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#KBCategory#KBCategory_Addreviewowner.
- [Delete] action
-
Endpoint URL address:
/kbRootCategories/{{=parameters.rootCategory_id}}/reviewOwners/remove.The action has the following user-defined parameters:
- rootCategory_id: Required. Specify root category identifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#KBCategory#KBCategory_Removereviewowner.
- id
Template: ShortText.
- photoURL
Template: ShortText.
- name
Template: ShortText.
- reviewOwnerIds
Template: LongText. A composite field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/contracts.
The result is extracted from:{{=response.data}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Contracts#Contracts_Listallcontracts.
- [Read single] action
-
Endpoint URL address:
/contracts/{{=parameters.contract_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- contract_id: Required. Specify contract identifier.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#KBCategory#KBCategory_Getrootcategory.
- [Create] action
-
Endpoint URL address:
/contracts.Documentation: https://desk.zoho.com/DeskAPIDocument#Contracts#Contracts_Createacontract.
- [Update] action
-
Endpoint URL address:
/contracts/{{=item.id}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Contracts#Contracts_Updateacontract.
- [Delete] action
-
Endpoint URL address:
/contracts/moveToTrash.Documentation: https://desk.zoho.com/DeskAPIDocument#Contracts#Contracts_Deletecontracts.
The resource includes the fields from the contractT template.
- [External]
-
The external fields URL address:
/organizationFields. The external fields list is extracted from:{{=ZohoDesk.getCustomFields(response.data)}}.
Based on resource template NoLimit.
- [Read] action
-
Endpoint URL address:
/timeTrackSettings.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- depId: Required. Specify department identifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#Timetracking#Timetracking_GetTimeTrackSettings.
- [Create] action
-
Endpoint URL address:
/timeTrackSettings.Documentation: https://desk.zoho.com/DeskAPIDocument#Timetracking#Timetracking_CreateTimeTrackSettings.
- [Update] action
-
Endpoint URL address:
/timeTrackSettings.
The action uses PUT method.Documentation: https://desk.zoho.com/DeskAPIDocument#Timetracking#Timetracking_UpdateTimeTrackSettings.
- ticketPreference
Field components:
-
Uses template:
ShortText. - Contains the following components: autoTrackAction, isReviewTime, isAutoPause, isAutoTimer, isHideTimeTracking.
-
Uses template:
- billingType
Template: ShortText.
- activityPreference
Field components:
-
Uses template:
ShortText. - Contains the following components: isTasksEnabled, trackMode, isEventsEnabled, canAutoTrackCalls.
-
Uses template:
- fixedCost
Data type: DT_R8
- profiles
Field components:
- An array.
- Contains the following components: id, cost.
- depId
Template: ShortText.
- isTimeTracking
Template: ShortText.
- isBillable
Template: ShortText.
- agents
Field components:
- An array.
- Contains the following components: cost, id.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/timeTrackHistory.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- depId: Required. Specify department identifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#Timetracking_ListhistorydetailsofbillingTimeTrackSettings.
- owner
Field components:
- An array.
-
Uses template:
authorT.
- newValue
Template: ShortText.
- modifiedTime
Template: DateTime. A read-only field.
- name
Template: ShortText.
- modifiedBy
Template: ShortText.
- oldValue
Template: ShortText.
- modifiedAgent
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/views.
The result is extracted from:{{=response.data}}.The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#Views_ListViews.
-
limit:
- [Read last] action
-
Endpoint URL address:
/lastAccessedView.
The result is extracted from:{{=response.data}}.The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#Views#Views_GetLastAccessedView.
-
limit:
- [Read star] action
-
Endpoint URL address:
/starredViews.
The result is extracted from:{{=response.starredViews}}.The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#Views#Views_ListStarredViews.
-
limit:
- [Update] action
-
Endpoint URL address:
/lastAccessedView/{{=item.id}}.
The action uses PUT method.The action has the following user-defined parameters:
- departmentId: Optional. Specify the department identifier in which view are configured.
The following request parameters will be automatically processed:
-
departmentId:
{{=parameters.get('departmentid')
Documentation: https://desk.zoho.com/DeskAPIDocument#Views#Views_UpdateLastAccessedView.
- id
A key field. Template: ShortText.
- isCustomView
Data type: DT_BOOL
- name
Template: ShortText.
- count
Data type: DT_I4 A read-only field.
- action
Template: ShortText. Field components:
- Contains the following components: addStar, removeStar.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/{{=parameters.module}}/{{=parameters.module_id}}/timeEntry.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- module: Required. Select module.
- module_id: Required. Specify the module identifier.
- [Read single] action
-
Endpoint URL address:
/{{=parameters.module}}/{{=parameters.module_id}}/timeEntry/timeEntry/{{=parameters.timeEntry_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- module: Required. Select module.
- module_id: Required. Specify the module identifier.
- timeEntry_id: Required. Specify time entry identifier.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
- [Read billing type] action
-
Endpoint URL address:
/tickets/{{=parameters.ticket_id}}/timeEntry/timeEntryByBillingType.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- ticket_id: Required. Specify the ticket identifier.
- billingType: Required. Specify the billing Type.
Documentation: https://desk.zoho.com/DeskAPIDocument#TicketTimeEntry#TicketTimeEntry_GetTicketTimeEntriesbyBillingType.
- [Create] action
-
Endpoint URL address:
/{{=parameters.module}}/{{=parameters.module_id}}/timeEntry.The action has the following user-defined parameters:
- module: Required. Select module.
- module_id: Required. Specify the module identifier.
- [Update] action
-
Endpoint URL address:
/{{=parameters.module}}/{{=parameters.module_id}}/timeEntry/{{=item.id}}.The action has the following user-defined parameters:
- module: Required. Select module.
- module_id: Required. Specify the module identifier.
- [Delete] action
-
Endpoint URL address:
/{{=parameters.module}}/{{=parameters.module_id}}/timeEntry/{{=item.id}}.
The action uses DELETE method.The action has the following user-defined parameters:
- module: Required. Select module.
- module_id: Required. Specify the module identifier.
- id
A key field. Template: ShortText.
- owner
Template: authorT.
- parent
Field components:
-
Uses template:
ShortText. - Contains the following components: id, ticketNumber, subject, type.
-
Uses template:
- secondsSpent
Data type: DT_I4
- executedTime
Template: DateTime. A read-only field.
- departmentId
Template: ShortText.
- fixedCost
Template: ShortText.
- minutesSpent
Data type: DT_I4
- creatorId
Template: ShortText.
- agentCostPerHour
Data type: DT_R8
- description
Template: VeryLongText.
- hoursSpent
Template: ShortText.
- ownerId
Template: ShortText.
- isBillable
Data type: DT_BOOL
- mode
Template: ShortText.
- isTrashed
Template: ShortText.
- billingType
Template: ShortText.
- createdTime
Template: DateTime. A read-only field.
- invoiceId
Template: ShortText.
- requestChargeType
Template: ShortText.
- additionalCost
Data type: DT_R8
- totalCost
Data type: DT_R8
- [External]
-
The external fields URL address:
/organizationFields. The external fields list is extracted from:{{=ZohoDesk.getCustomFields(response.data)}}. - [External]
-
The external fields URL address:
/organizationFields. The external fields list is extracted from:{{=ZohoDesk.getCustomFields(response.data)}}.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/tickets/{{=parameters.ticket_id}}/approvals.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- ticket_id: Required. Specify the ticket identifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#TicketApprovals#TicketApprovals_Listapprovals.
- [Read single] action
-
Endpoint URL address:
/tickets/{{=parameters.ticket_id}}/approvals/{{=parameters.approval_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- ticket_id: Required. Specify ticket identifier.
- approval_id: Required. Specify approval identifier.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#TicketApprovals#TicketApprovals_Getapproval.
- [Create] action
-
Endpoint URL address:
/tickets/{{=parameters.ticket_id}}/approvals.The action has the following user-defined parameters:
- ticket_id: Required. Specify ticket identifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#TicketApprovals#TicketApprovals_Createapproval.
- [Update] action
-
Endpoint URL address:
/tickets/{{=parameters.ticket_id}}/approvals/{{=item.id}}.The action has the following user-defined parameters:
- ticket_id: Required. Specify ticket identifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#TicketApprovals#TicketApprovals_Updateapproval.
- id
A key field. Template: ShortText.
- approver
Template: authorT.
- requester
Template: authorT.
- requestedTime
Template: DateTime. A read-only field.
- subject
Template: ShortText.
- processedTime
Template: DateTime. A read-only field.
- description
Template: ShortText.
- status
Template: ShortText.
- approverIds
Template: LongText. A composite field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/ticketTags.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- departmentId: Required. Specify department identifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#TicketTags#TicketTags_Listtickettags.
- [Read search] action
-
Endpoint URL address:
/tags/search.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- departmentId: Required. Specify department identifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#TicketTags#TicketTags_Searchtags.
- [Read recent] action
-
Endpoint URL address:
/recentTicketTags.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- departmentId: Required. Specify department identifier.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#TicketTags#TicketTags_Listrecenttags.
- [Update] action
-
Endpoint URL address:
/recentTicketTags/{{=item.id}}.Documentation: https://desk.zoho.com/DeskAPIDocument#TicketTags#TicketTags_Updaterecenttags.
The resource includes the fields from the ticketT template.
- id
A key field. Template: ShortText.
- tags
Template: LongText. A composite field.
- name
Template: ShortText.
- tagType
Template: ShortText.
- status
Template: ShortText.
- action
Template: ShortText. Field components:
- Contains the following components: associateTag, dissociateTag.
- [External]
-
The external fields URL address:
/organizationFields. The external fields list is extracted from:{{=ZohoDesk.getCustomFields(response.data)}}.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/customerHappiness.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- departmentId: Required. Specify department identifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#CustomerHappiness_ListallcustomerHappiness.
- id
A key field. Template: ShortText.
- agentId
Template: ShortText.
- agent
Template: authorT.
- ticket
Template: ticketT.
- contactId
Template: ShortText.
- departmentId
Template: ShortText.
- rating
Template: ShortText.
- threadId
Template: ShortText.
- feedback
Template: ShortText.
- accountId
Template: ShortText.
- ratedTime
Template: DateTime. A read-only field.
- customerRatedTime
Template: DateTime. A read-only field.
- timezoneOffset
Template: ShortText.
- contact
Template: contactT.
- ticketId
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/ticketTemplates.
The result is extracted from:{{=response.data}}.Documentation: https://desk.zoho.com/DeskAPIDocument#TicketTemplates#TicketTemplates_Listtickettemplates.
- [Read single] action
-
Endpoint URL address:
/ticketTemplates/{{=parameters.ticketTemplates_id}}.The action has the following user-defined parameters:
- ticketTemplates_id: Required. Specify ticket template identifier.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#TicketTemplates#TicketTemplates_Gettickettemplate.
- [Create] action
-
Endpoint URL address:
/ticketTemplates.Documentation: https://desk.zoho.com/DeskAPIDocument#TicketTemplates#TicketTemplates_Createtickettemplate.
- [Update] action
-
Endpoint URL address:
/ticketTemplates/{{=item.id}}.Documentation: https://desk.zoho.com/DeskAPIDocument#TicketTemplates#TicketTemplates_Updatetickettemplate.
- [Delete] action
-
Endpoint URL address:
/ticketTemplates/{{=item.id}}.Documentation: https://desk.zoho.com/DeskAPIDocument#TicketTemplates#TicketTemplates_Deletetickettemplate.
- id
Template: ShortText.
- showInCustomerPortal
Data type: DT_BOOL
- ticketTemplateName
Template: ShortText.
- ids
Template: LongText. A composite field.
- layoutId
Template: ShortText.
- ticketTemplateValues
Field components:
-
Uses template:
ShortText. - Contains the following components: subCategory, product, cf, productId, contactId, subject, departmentId, dueDate, channel, description, secondaryContacts, priority, classification, assigneeId, accountId, phone, contact, department, category, account, team, email, status, assignee.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
{{=ZohoDesk.getCommentsBase(parameters)}}.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- module: Required. Specify the desired module accounts or tickets.
- module_id: Required. Specify the selected module identifier (e.g) ticket_id value.
- locale: Specify only if the selected module is articles. Optional.
- [Read single] action
-
Endpoint URL address:
{{=ZohoDesk.getCommentsBase(parameters)}}/{{=parameters.comment_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- module: Required. Specify the desired module accounts or tickets.
- module_id: Required. Specify the selected module identifier (e.g) ticket_id value.
- comment_id: Required. Specify the comment identifier.
- locale: Specify only if the selected module is articles. Optional.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
- [Read topic] action
-
Endpoint URL address:
/communityTopics/{{=parameters.topic_id}}/comments.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- topic_id: Required. Specify topic identifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#Community#Community_Listtopiccomments.
- [Create] action
-
Endpoint URL address:
{{=ZohoDesk.getCommentsBase(parameters)}}.The action has the following user-defined parameters:
- module: Required. Specify the desired module accounts or tickets.
- module_id: Required. Specify the selected module identifier (e.g) ticket_id value.
- locale: Specify only if the selected module is articles. Optional.
- [Update] action
-
Endpoint URL address:
{{=ZohoDesk.getCommentsBase(parameters)}}/{{=item.id}}.The action has the following user-defined parameters:
- module: Required. Specify the desired module accounts or tickets.
- module_id: Required. Specify the selected module identifier (e.g) ticket_id value.
- locale: Specify only if the selected module is articles. Optional.
- [Delete] action
-
Endpoint URL address:
{{=ZohoDesk.getCommentsBase(parameters)}}/{{=item.id}}.The action has the following user-defined parameters:
- module: Required. Specify the desired module accounts or tickets.
- module_id: Required. Specify the selected module identifier (e.g) ticket_id value.
- locale: Specify only if the selected module is articles. Optional.
- id
A key field. Template: ShortText.
- modifiedTime
Template: DateTime. A read-only field.
- attachments
Field components:
- An array.
-
Uses template:
attachmentT.
- commentedTime
Template: DateTime.
- isPublic
Data type: DT_BOOL
- contentType
Template: ShortText.
- commenterId
Template: ShortText.
- content
Template: ShortText.
- mention
Field components:
- An array.
-
Uses template:
authorT. - Contains the following components: offSet, length.
- commenter
Template: authorT. Field components:
-
Uses template:
ShortText. - Contains the following components: roleName.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/{{=parameters.module}}/{{=parameters.module_id}}/attachments.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- module: Required. Specify the desired module accounts or tickets.
- module_id: Required. Specify the selected module identifier (e.g) ticket_id value.
- [Create] action
-
Endpoint URL address:
/{{=parameters.module}}/{{=parameters.module_id}}/attachments.The action has the following user-defined parameters:
- module: Required. Specify the desired module accounts or tickets.
- module_id: Required. Specify the selected module identifier (e.g) ticket_id value.
- isPublic: Optional. Specify if the attachment is Public or Private.
The following request parameters will be automatically processed:
-
file:
{{=item.content}} -
isPublic:
{{=parameters.get('isPublic')}}
- [Update] action
-
Endpoint URL address:
/{{=parameters.module}}/{{=parameters.module_id}}/attachments/{{=item.id}}.The action has the following user-defined parameters:
- module: Required. Specify the module tickets.
- module_id: Required. Specify the selected module identifier (e.g) ticket_id value.
- isPublic: Optional. Specify if the attachment is Public or Private.
The following request parameters will be automatically processed:
-
application/json:
{{=item}} -
isPublic:
{{=parameters.get('isPublic')}}
- [Delete] action
-
Endpoint URL address:
/{{=parameters.module}}/{{=parameters.module_id}}/attachments/{{=item.id}}.
The action uses DELETE method.The action has the following user-defined parameters:
- module: Required. Specify the module tickets or accounts.
- module_id: Required. Specify the selected module identifier (e.g) ticket_id value.
- id
A key field. Template: ShortText.
- creator
Template: authorT.
- size
Template: ShortText.
- creatorId
Template: ShortText.
- name
Template: ShortText.
- createdTime
Template: DateTime. A read-only field.
- isPublic
Data type: DT_BOOL
- href
Template: ShortText.
- filename
Template: ShortText.
- content
Data type: DT_IMAGE
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/{{=parameters.module}}/{{=parameters.module_id}}/followers.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- module: Required. Specify the desired module accounts, contacts or tickets.
- module_id: Required. Specify the selected module identifier (e.g) ticket_id value.
The following request parameters will be automatically processed:
-
limit:
{{=parameters.module == 'tickets' ? undefined : parameters.batchSize}}
- [Read topic] action
-
Endpoint URL address:
/communityTopics/{{=parameters.topic_id}}/followers.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- topic_id: Required. Specify the topic identifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#Community#Community_Listtopicfollowers.
- [Create] action
-
Endpoint URL address:
/{{=parameters.module}}/{{=parameters.module_id}}/addFollowers.The action has the following user-defined parameters:
- module: Required. Specify the desired module accounts, contacts or tickets.
- module_id: Required. Specify the selected module identifier (e.g) ticket_id value.
- [Delete] action
-
Endpoint URL address:
/{{=parameters.module}}/{{=parameters.module_id}}/removeFollowers.The action has the following user-defined parameters:
- module: Required. Specify the module tickets, contacts or accounts.
- module_id: Required. Specify the selected module identifier (e.g) ticket_id value.
- id
A key field. Template: ShortText.
- firstName
Template: ShortText. A read-only field.
- lastName
Template: ShortText. A read-only field.
- photoURL
Template: ShortText. A read-only field.
Template: ShortText. A read-only field.
- followerIds
Template: LongText. A composite field.
Based on resource template Base.
- [Read ticket] action
-
Endpoint URL address:
/tickets/{{=parameters.ticket_id}}/activities.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- ticket_id: Required. Specify the ticket identifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#Activities#Activities_Listticketactivities.
- [Read search] action
-
Endpoint URL address:
/activities/search.
The result is extracted from:{{=response.data}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Search#Search_SearchActivities.
The resource includes the fields from the ActivityT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/calls.
The result is extracted from:{{=response.data}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Calls#Calls_Listcalls.
- [Read search] action
-
Endpoint URL address:
/calls/search.
The result is extracted from:{{=response.data}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Search#Search_CallSearchAPI.
- [Read single] action
-
Endpoint URL address:
/calls/{{=parameters.call_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- call_id: Required. Specify call identifier.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#Calls#Calls_Getcall.
- [Read ticket] action
-
Endpoint URL address:
/tickets/{{=parameters.ticket_id}}/calls.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- ticket_id: Required. Specify ticket identifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#Calls#Calls_Listcallsbyticket.
- [Create] action
-
Endpoint URL address:
/calls.Documentation: https://desk.zoho.com/DeskAPIDocument#Calls#Calls_Createcall.
- [Update] action
-
Endpoint URL address:
/calls/{{=item.id}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Calls#Calls_Updatecall.
- [Delete] action
-
Endpoint URL address:
/calls/moveToTrash.Documentation: https://desk.zoho.com/DeskAPIDocument#Calls#Calls_Deletecalls.
The resource includes the fields from the CallT template.
- action
Template: ShortText. Field components:
- Contains the following components: clearLiveCall.
- [External]
-
The external fields URL address:
/organizationFields. The external fields list is extracted from:{{=ZohoDesk.getCustomFields(response.data)}}.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/events.
The result is extracted from:{{=response.data}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Events#Events_Listevents.
- [Read single] action
-
Endpoint URL address:
/events/{{=parameters.event_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- event_id: Required. Specify event identifier.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#Calls#Calls_Getcall.
- [Read search] action
-
Endpoint URL address:
/events/search.
The result is extracted from:{{=response.data}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Search#Search_EventSearchAPI.
- [Read ticket] action
-
Endpoint URL address:
/tickets/{{=parameters.ticket_id}}/events.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- ticket_id: Required. Specify ticket identifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#Events#Events_Listeventsbyticket.
- [Create] action
-
Endpoint URL address:
/events.Documentation: https://desk.zoho.com/DeskAPIDocument#Events#Events_Createevent.
- [Update] action
-
Endpoint URL address:
/events/{{=item.id}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Events#Events_Updateevent.
- [Delete] action
-
Endpoint URL address:
/events/moveToTrash.Documentation: https://desk.zoho.com/DeskAPIDocument#Events#Events_Deleteevents.
The resource includes the fields from the EventT template.
- entityIds
Template: LongText. A composite field.
- [External]
-
The external fields URL address:
/organizationFields. The external fields list is extracted from:{{=ZohoDesk.getCustomFields(response.data)}}.
Based on resource template NoLimit.
- [Read] action
-
Endpoint URL address:
/modules.
The result is extracted from:{{=response.modules}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Modules#Modules_ListAllModules.
- [Read accessible] action
-
Endpoint URL address:
/myAccessibleModules.
The result is extracted from:{{=response.modules}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Modules#Modules_ListModulesaccessibletome.
- id
A key field. Template: ShortText.
- displayLabel
Template: ShortText.
- apiKey
Template: ShortText.
- isEnabled
Data type: DT_BOOL
- pluralLabel
Template: ShortText.
- singularLabel
Template: ShortText.
Based on resource template NoLimit.
- [Read country] action
-
Endpoint URL address:
/countries.
The result is extracted from:{{=response.data}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Locales#Locales_Listallcountries.
- [Read time zone] action
-
Endpoint URL address:
/timeZones.
The result is extracted from:{{=response.data}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Locales#Locales_Listalltimezones.
- [Read language] action
-
Endpoint URL address:
/languages.
The result is extracted from:{{=[response]}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Locales#Locales_Listalltimezones.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- currencySymbol
Template: ShortText.
- currencyCode
Template: ShortText.
- languages
The gathered value is processed with
{{=_.map(value, function(v, k) { return { name: k, value: v }; })}}expression. Field components:- An array.
- Contains the following components: name, value.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/organizationFields.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- module: Required. Specify the module.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#OrganizationFields#OrganizationFields_Getorganizationfieldsinamodule.
- [Read single] action
-
Endpoint URL address:
/organizationFields/{{=parameters.field_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- module: Required. Specify the module.
- field_id: Required. Specify field identifier.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#OrganizationFields#OrganizationFields_GetField.
- [Create] action
-
Endpoint URL address:
/organizationFields.The action has the following user-defined parameters:
- module: Required. Specify the module.
The following request parameters will be automatically processed:
-
module:
{{=parameters.get('module')
Documentation: https://desk.zoho.com/DeskAPIDocument#OrganizationFields#OrganizationFields_CreateField.
- [Update] action
-
Endpoint URL address:
/organizationFields/{{=item.id}}.Documentation: https://desk.zoho.com/DeskAPIDocument#OrganizationFields#OrganizationFields_EditField.
- [Delete] action
-
Endpoint URL address:
/organizationFields/{{=item.id}}.Documentation: https://desk.zoho.com/DeskAPIDocument#OrganizationFields#OrganizationFields_DeleteField.
The resource includes the fields from the CustomFieldT template.
- permissions
A read-only field. The value is gathered from
/organizationFields/{{=item.id}}/permissionsaddress. The gathered value is processed with{{=response.data}}expression. The value is sent to/organizationFields/{{=item.id}}/permissionsaddress. Field components:- An array.
- Contains the following components: profileId, isReadOnly, isInVisibleAccess, isReadAccess, isInVisible, isWriteOnly, isWriteAccess, isCustomProfile, profileName.
- criteriaReferences
The value is gathered from
/organizationFields/{{=item.id}}/criteriaReferencesaddress. The gathered value is processed with{{=response.DirectAssignment}}expression. Field components:- An array.
- Contains the following components: id, name, encryptedId.
Based on resource template NoLimit.
- [Read] action
-
Endpoint URL address:
/customFieldCount.
The result is extracted from:{{=response.customFieldCounts}}.The action has the following user-defined parameters:
- module: Required. Specify the module.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#OrganizationFields#OrganizationFields_Getorganizationcustomfieldscountinamodule.
- types
Template: LongText. A composite field.
- maximumLimit
Data type: DT_I4
- available
Data type: DT_I4
- type
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/layouts.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- module: Required. Specify the module.
Documentation: https://desk.zoho.com/DeskAPIDocument#Layouts#Layouts_ListLayouts.
- [Read single] action
-
Endpoint URL address:
/layouts/{{=parameters.layout_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- layout_id: Required. Specify layout identifier.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#Layouts#Layouts_GetLayout.
- [Read my form] action
-
Endpoint URL address:
/myForm.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- layoutId: Required. Specify layout identifier.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#Layouts#Layouts_GetMyForm.
- [Read standard] action
-
Endpoint URL address:
/layouts/standardLayoutFormat.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- module: Required. Specify the module.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#Layouts#Layouts_StandardLayoutFormat.
- [Create] action
-
Endpoint URL address:
/layouts.Documentation: https://desk.zoho.com/DeskAPIDocument#Layouts#Layouts_CreateLayout.
- [Update] action
-
Endpoint URL address:
/layouts/{{=item.id}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Layouts#Layouts_UpdateLayout.
- [Delete] action
-
Endpoint URL address:
/layouts/{{=item.id}}.
The action uses DELETE method.Documentation: https://desk.zoho.com/DeskAPIDocument#Layouts#Layouts_DeleteLayout.
- id
A key field. Template: ShortText.
- modifiedTime
Template: DateTime. A read-only field.
- skipDeptAccessValidation
Data type: DT_BOOL
- createdBy
Template: ShortText.
- departmentId
Template: ShortText.
- layoutDisplayName
Template: ShortText.
- layoutName
Template: ShortText.
- photoURL
Template: ShortText.
- layoutDesc
Data type: DT_NTEXT
- module
Template: ShortText.
- createdTime
Template: DateTime. A read-only field.
- modifiedBy
Template: ShortText.
- isDefaultLayout
Data type: DT_BOOL
- isStandardLayout
Data type: DT_BOOL
- hasLogo
Data type: DT_BOOL
- status
Template: ShortText.
- sections
The value is gathered from
/layouts/{{=item.id}}address. The gathered value is processed with{{=response.sections}}expression. Field components:- An array.
- Contains the following components: id, name, isCustomSection, fields.
- profiles
A read-only field. The value is gathered from
/layouts/{{=item.id}}/profilesaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
- Contains the following components: id, profileName, isDefault, type.
- rules
A read-only field. The value is gathered from
/layoutRulesaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
-
Uses template:
RuleT.
- action
Template: ShortText. Field components:
-
Uses template:
ActionT. - Contains the following components: activate, deactivate, clone.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/{{=parameters.rule_type}}Rules.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- rule_type: Required. Select rule type.
- [Read single] action
-
Endpoint URL address:
/layouts/{{=parameters.layout_id}}/layoutRules/{{=parameters.layoutRule_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- layout_id: Required. Specify layout identifier.
- layoutRule_id: Required. Specify layout rule identifier.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#LayoutRules#LayoutRules_GetLayoutRule.
- [Create] action
-
Endpoint URL address:
/layouts/{{=parameters.layout_id}}/{{=parameters.rule_type}}Rules.The action has the following user-defined parameters:
- layout_id: Required. Specify layout identifier.
- rule_type: Required. Select rule type.
- [Update] action
-
Endpoint URL address:
/layouts/{{=parameters.layout_id}}/{{=parameters.rule_type}}Rules/{{=item.id}}.The action has the following user-defined parameters:
- layout_id: Required. Specify layout identifier.
- rule_type: Required. Select rule type.
- [Delete] action
-
Endpoint URL address:
/layouts/{{=parameters.layout_id}}/{{=parameters.rule_type}}Rules/{{=item.id}}.
The action uses DELETE method.The action has the following user-defined parameters:
- layout_id: Required. Specify layout identifier.
- rule_type: Required. Select rule type.
The resource includes the fields from the RuleT template.
- criteriaFields
A read-only field. The value is gathered from
/layouts/{{=parameters.layoutId}}/{{=parameters.get('rule_type') || 'layout'}}Rules/criteriaFieldsaddress. The gathered value is processed with{{=response[field.name]}}expression. Field components:-
Uses template:
ShortText. - Contains the following components: name, displayLabel, fieldDetails.
-
Uses template:
Based on resource template NoLimit.
- [Read] action
-
Endpoint URL address:
/dependencyMappings.
The result is extracted from:{{=response.data}}.Documentation: https://desk.zoho.com/DeskAPIDocument#DependencyMappings#DependencyMappings_Listdependencymappingsinalayout.
- [Read possible] action
-
Endpoint URL address:
/availableDependencyMappings.The action has the following user-defined parameters:
- layoutId: Required. Specify layout identifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#DependencyMappings#DependencyMappings_Getpossibledependencymappingsinalayout.
- [Create] action
-
Endpoint URL address:
/dependencyMappings.Documentation: https://desk.zoho.com/DeskAPIDocument#DependencyMappings#DependencyMappings_Createdependencymapping.
- [Update] action
-
Endpoint URL address:
/dependencyMappings/{=item.id}}.Documentation: https://desk.zoho.com/DeskAPIDocument#DependencyMappings#DependencyMappings_Updatedependencymapping.
- [Delete] action
-
Endpoint URL address:
/dependencyMappings/{=item.id}}.
The action uses DELETE method.Documentation: https://desk.zoho.com/DeskAPIDocument#MailReplyAddress#MailReplyAddress_GetdetailsofaMailReplyAddress.
- id
A key field. Template: ShortText.
- layoutId
Template: ShortText.
- parentId
Template: ShortText.
- childId
Template: ShortText.
- parent
A read-only field. Field components:
- An array.
-
Uses template:
mappingT.
- child
Template: mappingT. A read-only field.
- children
Field components:
- An array.
-
Uses template:
mappingT.
- parents
Field components:
- An array.
-
Uses template:
mappingT.
- mappings
The gathered value is processed with
{{=_.map(value, function(v, k) { return { name: k, value: v}; })}}expression. Field components:- An array.
- Contains the following components: name, value.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/mailReplyAddress.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- departmentId: Required. Specify the department identifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#MailReplyAddress#MailReplyAddress_ListMailReplyAddresses.
- [Read single] action
-
Endpoint URL address:
/mailReplyAddress/{{=parameters.mailReplyAddress_id}}.
The result is extracted from:{{=[response.data]}}.The action has the following user-defined parameters:
- mailReplyAddress_id: Required. Specify mail reply address identifier.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#MailReplyAddress#MailReplyAddress_GetdetailsofaMailReplyAddress.
- [Create] action
-
Endpoint URL address:
/mailReplyAddress.Documentation: https://desk.zoho.com/DeskAPIDocument#MailReplyAddress#MailReplyAddress_AddMailReplyAddress.
- [Update] action
-
Endpoint URL address:
/mailReplyAddress/{{=item.id}}.Documentation: https://desk.zoho.com/DeskAPIDocument#MailReplyAddress#MailReplyAddress_UpdateMailReplyAddress.
- [Delete] action
-
Endpoint URL address:
/mailReplyAddress/{{=item.id}}.
The action uses DELETE method.Documentation: https://desk.zoho.com/DeskAPIDocument#MailReplyAddress#MailReplyAddress_DeleteMailReplyAddress.
- id
A key field. Template: ShortText.
- address
Template: ShortText.
- smtpDetails
Field components:
-
Uses template:
ShortText. - Contains the following components: port, host, userName, connectionType.
-
Uses template:
- isVerified
Data type: DT_BOOL A read-only field.
- isSmtpEnabled
Data type: DT_BOOL
- displayName
Template: ShortText.
- departmentId
Template: ShortText.
- isActive
Data type: DT_BOOL
- serviceProviderType
Template: ShortText.
- action
Template: ShortText. Field components:
- Contains the following components: sendVerification.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/supportEmailAddress.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- departmentId: Required. Specify the department identifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#SupportEmailAddress#SupportEmailAddress_ListSupportEmailAddresses.
- [Read single] action
-
Endpoint URL address:
/supportEmailAddress/{{=parameters.supportEmailAddress_id}}.
The result is extracted from:{{=[response.data]}}.The action has the following user-defined parameters:
- supportEmailAddress_id: Required. Specify support email address identifier.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#SupportEmailAddress#SupportEmailAddress_GetdetailsofaSupportEmailAddress.
- [Create] action
-
Endpoint URL address:
/supportEmailAddress.Documentation: https://desk.zoho.com/DeskAPIDocument#SupportEmailAddress#SupportEmailAddress_AddSupportEmailAddress.
- [Update] action
-
Endpoint URL address:
/supportEmailAddress/{{=item.id}}.Documentation: https://desk.zoho.com/DeskAPIDocument#SupportEmailAddress#SupportEmailAddress_UpdateSupportEmailAddress.
- [Delete] action
-
Endpoint URL address:
/supportEmailAddress/{{=item.id}}.
The action uses DELETE method.Documentation: https://desk.zoho.com/DeskAPIDocument#SupportEmailAddress#SupportEmailAddress_DeleteSupportEmailAddress.
- id
A key field. Template: ShortText.
- address
Template: ShortText.
- departmentId
Template: ShortText.
- friendlyName
Template: ShortText.
- isMailFetching
Data type: DT_BOOL
Based on resource template NoLimit.
- [Read department] action
-
Endpoint URL address:
/departments/{{=ZohoDesk.UI.DepartmentEditor.getValue(parameters)}}/mailConfigurations.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- department_id: Required. Specify department identifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#SupportEmailAddress#SupportEmailAddress_ListSupportEmailAddresses.
- [Read organization] action
-
Endpoint URL address:
/mailConfigurations.
The result is extracted from:{{=[response]}}.Documentation: https://desk.zoho.com/DeskAPIDocument#MailConfigurations#MailConfigurations_Listorganization-levelMailConfigurations.
- [Update] action
-
Endpoint URL address:
{{=parameters.get('department_id') ? '/departments/' + ZohoDesk.UI.DepartmentEditor.getValue(parameters) : ''}}/mailConfigurations.The action has the following user-defined parameters:
- department_id: Specify department identifier. If not specified, the organization configuration will be updated instead.
Documentation: https://desk.zoho.com/DeskAPIDocument#MailConfigurations#MailConfigurations_Updatedepartment-level%C2%A0MailConfigurations.
- privateThreadConfig
Data type: DT_BOOL
- agentNameInTicketReply
Data type: DT_BOOL
- createContactWithReplyTo
Data type: DT_BOOL
- createTicketForOriginalSender
Data type: DT_BOOL
- autoCCToMailbox
Data type: DT_BOOL
Based on resource template NoLimit.
- [Read] action
-
Endpoint URL address:
/supportEmailDomain.
The result is extracted from:{{=[response]}}.Documentation: https://desk.zoho.com/DeskAPIDocument#SupportEmailDomain#SupportEmailDomain_GetSupportEmailAddressSubDomain.
- [Update] action
-
Endpoint URL address:
/supportEmailDomain.Documentation: https://desk.zoho.com/DeskAPIDocument#SupportEmailDomain#SupportEmailDomain_UpdateSupportEmailAddressSubDomain.
- updatedTime
Template: DateTime. A read-only field.
- updatedBy
A key field. Template: ShortText.
- supportEmailDomain
Template: ShortText.
- oldDomain
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/businessHours.
The result is extracted from:{{=response.data}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Businesshours#Businesshours_Listbusinesshoursets.
- [Read single] action
-
Endpoint URL address:
/businessHours/{{=parameters.businessHour_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- businessHour_id: Required. Specify the business hour identifier.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#Businesshours#Businesshours_Getbusinesshoursset.
- [Create] action
-
Endpoint URL address:
/businessHours.Documentation: https://desk.zoho.com/DeskAPIDocument#Businesshours#Businesshours_Createbusinesshoursset.
- [Update] action
-
Endpoint URL address:
/businessHours/{{=item.id}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Businesshours#Businesshours_Updatebusinesshoursset.
- [Delete] action
-
Endpoint URL address:
/businessHours/{{=item.id}}.
The action uses DELETE method.Documentation: https://desk.zoho.com/DeskAPIDocument#Businesshours#Businesshours_Updatebusinesshoursset.
- id
Template: ShortText. A read-only field.
- modifiedTime
Template: DateTime. A read-only field.
- createdBy
Template: ShortText.
- holidayListId
Template: ShortText.
- timeZoneId
Template: ShortText.
- holidayListName
Template: ShortText.
- holidayListStatus
Template: ShortText.
- associatedHolidayList
Template: ShortText.
- name
Template: ShortText.
- businessTimes
Field components:
- An array.
- Contains the following components: startTime, endTime, day.
- timeZone
Template: infoT.
- createdTime
Template: DateTime. A read-only field.
- modifiedBy
Template: ShortText.
- type
Template: ShortText.
- status
Template: ShortText.
- automation_rules
A read-only field. The value is gathered from
/businessHours/{{=item.id}}/relatedRulesaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
- Contains the following components: ruleName, ruleId, ruleType.
Based on resource template NoLimit.
- [Read] action
-
Endpoint URL address:
/blueprints.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- module: Required. Specify the module of the blueprint to be listed.
Documentation: https://desk.zoho.com/DeskAPIDocument#Blueprints#Blueprints_Listallblueprintsinadepartment.
- [Read single] action
-
Endpoint URL address:
/blueprints/{{=parameters.blueprint_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- blueprint_id: Required. Specify the blueprint identifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#Blueprints#Blueprints_GetBlueprintDetails.
- [Create] action
-
Endpoint URL address:
/blueprints.Documentation: https://desk.zoho.com/DeskAPIDocument#Blueprints#Blueprints_CreateBlueprint.
- [Update] action
-
Endpoint URL address:
/blueprints/{{=item.id}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Blueprints#Blueprints_Updateablueprint.
- [Delete] action
-
Endpoint URL address:
/blueprints/{{=item.id}}.
The action uses DELETE method.Documentation: https://desk.zoho.com/DeskAPIDocument#Blueprints#Blueprints_DeleteBlueprint.
- id
A key field. Template: ShortText.
- criteria
Template: criteriaT.
- modifiedTime
Template: DateTime. A read-only field.
- orderNumber
Data type: DT_I4
- createdUserZUID
Data type: DT_I4
- departmentId
Template: ShortText.
- modifiedUserZUID
Data type: DT_I4
- active
Data type: DT_BOOL
- module
Template: ShortText.
- isDraft
Data type: DT_BOOL
- description
Template: ShortText.
- type
Template: ShortText.
- transitions
Field components:
- An array.
-
Uses template:
TransitionT.
- layoutId
Template: ShortText.
- states
Field components:
- An array.
- Contains the following components: id, timeInMins, escalations, transitionsOrder, businessHrId, name, type.
- chartData
Field components:
- Contains the following components: canvasPosition, connectionDetails, stateDetails.
- name
Template: ShortText.
- connections
Field components:
- An array.
- Contains the following components: fromState, toState, transition.
- fieldId
Template: ShortText.
- i18nFieldLabel
Template: ShortText.
- fieldLabel
Template: ShortText.
- ticketId
A key field. Template: ShortText.
- createdTime
Template: DateTime. A read-only field.
- message
Template: LongText.
- status
Template: ShortText.
Based on resource template NoLimit.
- [Read created] action
-
Endpoint URL address:
/dashboards/createdTickets.
The result is extracted from:{{=response.ticketCount}}.The action has the following user-defined parameters:
- groupBy: Required. Specify the Key that groups the ticket count according to a particular attribute.
- duration: Required. Specify the Predefined time range from which the stats must be fetched.
Documentation: https://desk.zoho.com/DeskAPIDocument#Dashboards#Dashboards_Getcreatedticketscount.
- [Read onhold] action
-
Endpoint URL address:
/dashboards/onholdTickets.
The result is extracted from:{{=response.ticketCount}}.The action has the following user-defined parameters:
- groupBy: Required. Specify the Key that groups the ticket count according to a particular attribute.
- duration: Required. Specify the Predefined time range from which the stats must be fetched.
Documentation: https://desk.zoho.com/DeskAPIDocument#Dashboards#Dashboards_Getonholdticketscount.
- [Read closed] action
-
Endpoint URL address:
/dashboards/solvedTickets.
The result is extracted from:{{=response.ticketCount}}.The action has the following user-defined parameters:
- groupBy: Required. Specify the Key that groups the ticket count according to a particular attribute.
- duration: Required. Specify the Predefined time range from which the stats must be fetched.
Documentation: https://desk.zoho.com/DeskAPIDocument#Dashboards#Dashboards_Getclosedticketscount.
- [Read unresolved] action
-
Endpoint URL address:
/dashboards/backlogTickets.
The result is extracted from:{{=response.ticketCount}}.The action has the following user-defined parameters:
- groupBy: Required. Specify the Key that groups the ticket count according to a particular attribute.
- duration: Required. Specify the Predefined time range from which the stats must be fetched.
Documentation: https://desk.zoho.com/DeskAPIDocument#Dashboards#Dashboards_Getunresolvedticketscount.
- [Read reopened] action
-
Endpoint URL address:
/dashboards/reopenedTickets.
The result is extracted from:{{=response.ticketCount}}.The action has the following user-defined parameters:
- groupBy: Required. Specify the Key that groups the ticket count according to a particular attribute.
- duration: Required. Specify the Predefined time range from which the stats must be fetched.
Documentation: https://desk.zoho.com/DeskAPIDocument#Dashboards_Getreopenedticketscount.
- [Read field] action
-
Endpoint URL address:
/ticketsCountByFieldValues.
The result is extracted from:{{=_.isArray(response[parameters.field]) ? response[parameters.field] : [{ value: response[parameters.field] }]}}.The action has the following user-defined parameters:
- field: Required. Select field to filter by.
Documentation: https://desk.zoho.com/DeskAPIDocument#TicketCount#TicketCount_Getticketcountbyfield.
The resource includes the fields from the ticketCountT template.
Based on resource template NoLimit.
- [Read] action
-
Endpoint URL address:
/dashboards/ticketsResolutionTime.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- groupBy: Required. Specify the Key that groups the ticket count according to a particular attribute.
- duration: Required. Specify the Predefined time range from which the stats must be fetched.
Documentation: https://desk.zoho.com/DeskAPIDocument#Dashboards_Listresolutiontimes.
- totalAvgAgentTime
Template: ShortText.
- timeData
Field components:
- An array.
-
Uses template:
timeDataT.
- totalTicketCount
Data type: DT_I4
- totalAvgSystemTime
Template: ShortText.
- groupedBy
Template: ShortText.
Based on resource template NoLimit.
- [Read] action
-
Endpoint URL address:
/dashboards/responseTime.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- groupBy: Required. Specify the Key that groups the ticket count according to a particular attribute.
- isFirstResponse: Required. Specify the bool value.
- duration: Required. Specify the Predefined time range from which the stats must be fetched.
Documentation: https://desk.zoho.com/DeskAPIDocument#Dashboards#Dashboards_Listresponsetimes.
- [Read count] action
-
Endpoint URL address:
/dashboards/responseCount.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- groupBy: Required. Specify the Key that groups the thread count according to a particular attribute.
- duration: Required. Specify the Predefined time range from which the stats must be fetched.
Documentation: https://desk.zoho.com/DeskAPIDocument#Dashboards_Gettotalresponsecount.
- totalAvgAgentTime
Template: ShortText.
- timeData
Field components:
- An array.
-
Uses template:
timeDataT.
- groupedBy
Template: ShortText.
- totalResponseCount
Data type: DT_I4
- avg
Data type: DT_R8
- responseCount
Field components:
- An array.
-
Uses template:
ticketCountT.
Based on resource template NoLimit.
- [Read] action
-
Endpoint URL address:
/domains.
The result is extracted from:{{=response.data}}.Documentation: https://desk.zoho.com/DeskAPIDocument#DomainMapping#DomainMapping_Listdomains.
- [Create] action
-
Endpoint URL address:
/domains.Documentation: https://desk.zoho.com/DeskAPIDocument#DomainMapping#DomainMapping_Adddomain.
- domain
Template: ShortText.
- appliedTime
Template: DateTime. A read-only field.
- sslRequestStatus
Template: ShortText.
- sslRequestedBy
Template: ShortText.
- isVerified
Data type: DT_BOOL
- sslStatus
Template: ShortText.
- method
Template: ShortText.
- zdSecurityCode
Template: ShortText.
- sslRequestedTime
Template: DateTime.
- isApplied
Data type: DT_BOOL
- appliedBy
Template: ShortText.
- verifiedBy
Template: ShortText.
- verifiedTime
Template: DateTime. A read-only field.
- status
Template: ShortText.
- action
Template: ShortText. Field components:
- Contains the following components: verify, apply.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/communityTopics.
The result is extracted from:{{=response.data}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Community#Community_Listforumtopics.
- [Read single] action
-
Endpoint URL address:
/communityTopics/{{=parameters.topic_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- topic_id: Required. Specify the topic identifier.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#Community#Community_Gettopic.
- [Read permalink] action
-
Endpoint URL address:
/communityTopicByPermalink.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- permalink: Required. Specify the permalink of the topic.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#Community#Community_Gettopicbypermalink.
- [Read moderated] action
-
Endpoint URL address:
/communityModeratedTopics.
The result is extracted from:{{=response.data}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Community#Community_Listmoderatedtopics.
- [Read pending moderation] action
-
Endpoint URL address:
/communityModeration/topics.
The result is extracted from:{{=response.data}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Community#Community_Listtopicspendingmoderation.
- [Create] action
-
Endpoint URL address:
/communityTopics.Documentation: https://desk.zoho.com/DeskAPIDocument#Community#Community_Addtopic.
- [Update] action
-
Endpoint URL address:
/communityTopics/{{=item.id}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Community#Community_Updatetopic.
- [Delete] action
-
Endpoint URL address:
/communityTopics.
The action uses DELETE method.Documentation: https://desk.zoho.com/DeskAPIDocument#Community#Community_Permanentlydeletetopics.
The resource includes the fields from the CommunityTopicT template.
- moderatedBy
Template: CommunityUserT.
- trashedBy
Template: CommunityUserT.
- attachments
Field components:
- An array.
-
Uses template:
attachmentT.
- isFollowing
Data type: DT_BOOL
- isModerated
Data type: DT_BOOL
- moderatedOn
Template: DateTime. A read-only field.
- isVoted
Data type: DT_BOOL
- isSticky
Data type: DT_BOOL
- bestCommentId
Template: ShortText.
- content
Template: ShortText.
- portalUrl
Template: ShortText.
- isLocked
Data type: DT_BOOL
- followersCount
Data type: DT_I4
- tag
Field components:
- An array.
- Contains the following components: name, permalink.
- isTicketCreated
Data type: DT_BOOL
- tags
Template: LongText. A composite field.
- followers
The value is gathered from
/communityTopics/{{=item.id}}/followersaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
-
Uses template:
CommunityUserT.
- participants
The value is gathered from
/communityTopics/{{=item.id}}/participantsaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
-
Uses template:
CommunityUserT.
- voters
The value is gathered from
/communityTopics/{{=item.id}}/votersaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
-
Uses template:
CommunityUserT.
- comments
The value is gathered from
/communityTopics/{{=item.id}}/commentsaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
-
Uses template:
CommunityTopicCommentT.
- permalinks
Template: ActionT. The value is gathered from
/communityTopics/{{=item.id}}/permalinksaddress. The gathered value is processed with{{=response.data}}expression. The value is sent to/communityTopics/{{=item.id}}/permalinksaddress. Field components:- An array.
- Contains the following components: isPrimary, permalink.
- action
Template: ShortText. Field components:
-
Uses template:
ActionT. - Contains the following components: enable, moveToTrash, move, associateTags, dissociateTags, markSpam.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/communityTopics/{{=parameters.topic_id}}/comments.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- topic_id: Required. Specify the topic identifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#Community#Community_Listtopiccomments.
- [Read single] action
-
Endpoint URL address:
/communityTopics/{{=parameters.topic_id}}/comments/{{=parameters.comment_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- topic_id: Required. Specify the topic identifier.
- comment_id: Required. Specify the comment identifier.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#Community#Community_Gettopiccomment.
- [Create] action
-
Endpoint URL address:
/communityTopics/{{=parameters.topic_id}}/comments.The action has the following user-defined parameters:
- topic_id: Required. Specify the topic identifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#Community#Community_Addcomment.
- [Update] action
-
Endpoint URL address:
/communityTopics/{{=parameters.topic_id}}/comments/{{=item.id}}.The action has the following user-defined parameters:
- topic_id: Required. Specify the topic identifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#Community#Community_Updatecomment.
- [Delete] action
-
Endpoint URL address:
/communityTopics/{{=parameters.topic_id}}/comments/{{=item.id}}/moveToTrash.
The action uses POST method.The action has the following user-defined parameters:
- topic_id: Required. Specify the topic identifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#Community#Community_Trashcomment.
The resource includes the fields from the CommunityTopicCommentT template.
- attachmentIds
Template: LongText. A composite field.
- action
Template: ShortText. Field components:
-
Uses template:
ActionT. - Contains the following components: markSpam, addReply, updateReply, trashReply.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/communityCategory.
The result is extracted from:{{=response.categories}}.The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#Community#Community_Listcategories.
-
limit:
- [Read single] action
-
Endpoint URL address:
/communityCategory/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Specify category or forum identifier.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#Community#Community_Getcategoryorforum.
- [Read permalink] action
-
Endpoint URL address:
/communityCategoryByPermalink.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- permalink: Required. Specify the permalink of the category or forum.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#Community#Community_Getcategoryorforumbypermalink.
- [Create] action
-
Endpoint URL address:
/communityCategory.Documentation: https://desk.zoho.com/DeskAPIDocument#Community#Community_Addforum.
- [Update] action
-
Endpoint URL address:
/communityCategory/{{=item.id}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Community#Community_Updatecategoryorforum.
- [Delete] action
-
Endpoint URL address:
/communityCategory/{{=item.id}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Community#Community_Deleteforum.
The resource includes the fields from the CommunityCategoryT template.
- childs
Field components:
- An array.
-
Uses template:
CommunityCategoryT.
- groupIds
Template: LongText. A composite field.
- followers
The value is gathered from
/communityCategory/{{=item.id}}/followersaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
-
Uses template:
CommunityUserT.
- action
Template: ShortText. Field components:
- Contains the following components: enable.
Based on resource template Base.
- [Read moderated] action
-
Endpoint URL address:
/communityModeratedUsers.
The result is extracted from:{{=response.data}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Community_Listmoderatedusers.
- [Read followers] action
-
Endpoint URL address:
/communityUsers/{{=parameters.user_id}}/followers.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- user_id: Required. Specify community user dentifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#Community#Community_Listfollowersofuser.
- [Update] action
-
Endpoint URL address:
/communityUsers/{{=item.id}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Community#Community_Updateuserstatusincommunity.
The resource includes the fields from the CommunityUserT template.
- stats
A read-only field. The value is gathered from
/communityUsers/{{=item.id}}address. The gathered value is processed with{{=response.stats}}expression. Field components:- Contains the following components: postCount, topicTypeWiseCount, followersCount, commentCount.
- isModerated
Data type: DT_BOOL
- moderatedBy
Template: CommunityUserT.
- moderatedOn
Template: DateTime. A read-only field.
- topics
The value is gathered from
/communityUsers/{{=item.id}}/topicsaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
-
Uses template:
CommunityTopicT.
- comments
The value is gathered from
/communityTopics/{{=item.id}}/commentsaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
-
Uses template:
CommunityCommentT.
- action
Template: ShortText. Field components:
- Contains the following components: enable.
Based on resource template Base.
- [Read pending moderation] action
-
Endpoint URL address:
/communityModeration/comments.
The result is extracted from:{{=response.data}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Community#Community_Listcommentspendingmoderation.
- [Delete] action
-
Endpoint URL address:
/communityComments.
The action uses DELETE method.The following request parameters will be automatically processed:
-
application/json:
{{={ commentIds: _.pluck(batch, 'id') } }}
Documentation: https://desk.zoho.com/DeskAPIDocument#Community_Permanentlydeletecomments.
-
application/json:
The resource includes the fields from the CommunityCommentT template.
- trashedBy
Template: ShortText.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/communityTopics/saveDraft.Documentation: https://desk.zoho.com/DeskAPIDocument#Community#Community_Drafttopic.
- [Update] action
-
Endpoint URL address:
/communityTopics/{{=item.id}}/updateDraft.
The action uses PUT method.Documentation: https://desk.zoho.com/DeskAPIDocument#Community#Community_UpdateDraftedTopic.
- [Delete] action
-
Endpoint URL address:
/communityTopics/{{=item.id}}/deleteDraft.
The action uses DELETE method.Documentation: https://desk.zoho.com/DeskAPIDocument#Community#Community_Deletetopicdraft.
- id
A key field. Template: ShortText.
- subject
Template: LongText.
- attachmentIds
Template: LongText. A composite field.
- mailTo
Template: LongText. A composite field.
- type
Template: ShortText.
- isSticky
Template: ShortText.
- content
Template: ShortText.
- categoryId
Template: ShortText.
- notifyMe
Template: ShortText.
- tags
Template: LongText. A composite field.
- status
Template: ShortText.
- action
Template: ShortText. Field components:
- Contains the following components: publish.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/badges.Documentation: https://desk.zoho.com/DeskAPIDocument#Badgification#Badgification_Listbadges.
- [Create] action
-
Endpoint URL address:
/badges.Documentation: https://desk.zoho.com/DeskAPIDocument#Badgification#Badgification_Addbadge.
- [Update] action
-
Endpoint URL address:
/badges/{{=item.id}}.
The action uses PUT method.Documentation: https://desk.zoho.com/DeskAPIDocument#Badgification#Badgification_Updatebadge.
- [Delete] action
-
Endpoint URL address:
/badges/{{=item.id}}.
The action uses DELETE method.Documentation: https://desk.zoho.com/DeskAPIDocument#Badgification#Badgification_Deletebadge.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- isCustom
Template: ShortText.
- description
Template: VeryLongText.
- levelName
Template: ShortText.
- customIconId
Template: ShortText.
- iconUrl
Template: ShortText.
- users
The value is gathered from
/badges/{{=item.id}}/usersaddress. The gathered value is processed with{=response.users}}expression. Field components:- An array.
-
Uses template:
infoT.
- action
Template: ShortText. Field components:
-
Uses template:
ActionT. - Contains the following components: associateUsers, dissociateUsers.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/levels.Documentation: https://desk.zoho.com/DeskAPIDocument#Badgification#Badgification_Listlevels.
- [Create] action
-
Endpoint URL address:
/levels.Documentation: https://desk.zoho.com/DeskAPIDocument#Badgification#Badgification_Addlevel.
- [Update] action
-
Endpoint URL address:
/levels/{{=item.id}}.
The action uses PUT method.Documentation: https://desk.zoho.com/DeskAPIDocument#Badgification#Badgification_Updatelevel.
- [Delete] action
-
Endpoint URL address:
/levels/{{=item.id}}.
The action uses DELETE method.Documentation: https://desk.zoho.com/DeskAPIDocument#Badgification#Badgification_Deletelevel.
- id
A key field. Template: ShortText.
- badge
Template: infoT. Field components:
-
Uses template:
ShortText. - Contains the following components: iconUrl.
-
Uses template:
- name
Template: ShortText.
- description
Template: VeryLongText.
- pointsToReach
Data type: DT_I4
- badgeId
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/credits.Documentation: https://desk.zoho.com/DeskAPIDocument#Badgification#Badgification_Listcreditworthyactivities.
- [Create] action
-
Endpoint URL address:
/credits.Documentation: https://desk.zoho.com/DeskAPIDocument#Badgification#Badgification_Addcreditworthyactivity.
- [Update] action
-
Endpoint URL address:
/credits/{{=item.id}}.
The action uses PUT method.Documentation: https://desk.zoho.com/DeskAPIDocument#Badgification#Badgification_Updatecreditworthyactivity.
- [Delete] action
-
Endpoint URL address:
/credits/{{=item.id}}.
The action uses DELETE method.Documentation: https://desk.zoho.com/DeskAPIDocument#Badgification#Badgification_Deletecreditworthyactivity.
- id
A key field. Template: ShortText.
- isEnabled
Data type: DT_BOOL
- name
Template: ShortText.
- isCustom
Data type: DT_BOOL
- description
Template: VeryLongText.
- points
Data type: DT_I4
- users
The value is gathered from
/credits/{{=item.id}}/usersaddress. The gathered value is processed with{=response.users}}expression. Field components:- An array.
-
Uses template:
infoT.
- action
Template: ShortText. Field components:
-
Uses template:
ActionT. - Contains the following components: associateUsers, dissociateUsers.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/holidayList.
The result is extracted from:{{=response.data}}.Documentation: https://desk.zoho.com/DeskAPIDocument#HolidayList_Listholidaylists.
- [Read single] action
-
Endpoint URL address:
/holidayList/{{=parameters.holidaylist_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- holidaylist_id: Required. Specify holiday list dentifier.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#HolidayList#HolidayList_Getholidaylist.
- [Create] action
-
Endpoint URL address:
/holidayList.Documentation: https://desk.zoho.com/DeskAPIDocument#HolidayList#HolidayList_Createholidaylist.
- [Update] action
-
Endpoint URL address:
/holidayList/{{=item.id}}.Documentation: https://desk.zoho.com/DeskAPIDocument#HolidayList#HolidayList_Updateholidaylist.
- [Delete] action
-
Endpoint URL address:
/holidayList/{{=item.id}}.
The action uses DELETE method.Documentation: https://desk.zoho.com/DeskAPIDocument#HolidayList_Deleteholidaylist.
- id
A key field. Template: ShortText.
- modifiedTime
Template: DateTime. A read-only field.
- associatedBusinessHoursIds
Template: LongText. A composite field.
- associatedBusinessHours
Field components:
- An array.
- Contains the following components: businessHourStatus, businessHourId, businessHourName.
- holidays
Field components:
- An array.
- Contains the following components: from, to, holidayName.
- createdBy
Template: ShortText.
- name
Template: ShortText.
- createdTime
Template: DateTime. A read-only field.
- modifiedBy
Template: ShortText.
- status
Template: ShortText.
Based on resource template Base.
- [Read failure alert] action
-
Endpoint URL address:
/emailFailureAlerts.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- department: Required. Specify the identifier of the department.
Documentation: https://desk.zoho.com/DeskAPIDocument#Notification#Notification_Listemaildeliveryfailurealerts.
- [Read pending approvals] action
-
Endpoint URL address:
/myPendingApprovals.
The result is extracted from:{{=response.myPendingApprovals}}.The action has the following user-defined parameters:
- department: Required. Specify the identifier of the department.
Documentation: https://desk.zoho.com/DeskAPIDocument#Notification#Notification_Getmypendingapprovals.
- [Update] action
-
Endpoint URL address:
/emailFailureAlerts.The action has the following user-defined parameters:
- department: Required. Specify the identifier of the department.
Documentation: https://desk.zoho.com/DeskAPIDocument#Notification#Notification_Clearemaildeliveryfailurealerts.
- id
A key field. Template: ShortText.
- departmentName
Template: ShortText.
- threadId
Template: ShortText.
- ticketNumber
Data type: DT_I4
- reason
Template: LongText.
- subject
Template: LongText.
- departmentId
Template: ShortText.
- channel
Template: ShortText.
- errorMessage
Template: LongText.
- assignee
Template: authorT.
- requester
Template: authorT.
- createdTime
Template: DateTime. A read-only field.
- ticketId
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/dataSharingRules.
The result is extracted from:{{=[response]}}.Documentation: https://desk.zoho.com/DeskAPIDocument#DataSharingRules#DataSharingRules_Getdatasharingrules.
- [Update] action
-
Endpoint URL address:
/dataSharingRules.Documentation: https://desk.zoho.com/DeskAPIDocument#DataSharingRules#DataSharingRules_Updatedatasharingrules.
- tickets
Template: ShortText.
- calls
Template: ShortText.
- accounts
Template: ShortText.
- contracts
Template: ShortText.
- contacts
Template: ShortText.
- tasks
Template: ShortText.
- events
Template: ShortText.
- products
Template: ShortText.
Based on resource template NoLimit.
- [Read] action
-
Endpoint URL address:
/zohoFinance/{{=parameters.financeService}}/invoices.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- financeService: Required. Specify the financeService.
Documentation: https://desk.zoho.com/DeskAPIDocument#Finance#Finance_Listinvoices.
- [Update] action
-
Endpoint URL address:
/zohoFinance/{{=item.financeService}}/invoices/{{=item.id}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Finance#Finance_Updateinvoicestatus.
- id
A key field. Template: ShortText.
- date
Template: ShortText.
- total
Data type: DT_I4
- isViewdByClient
Data type: DT_BOOL
- totalFormatted
Template: ShortText.
- invoiceNumber
Template: ShortText.
- dateFormatted
Template: ShortText.
- currencyCode
Template: ShortText.
- statusFormatted
Template: ShortText.
- status
Template: ShortText.
- financeService
A key field. Template: ShortText.
Based on resource template NoLimit.
- [Read] action
-
Endpoint URL address:
/zohoFinance/{{=parameters.financeService}}/estimates.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- financeService: Required. Specify the financeService.
- deskModuleName: Required. Specify the Desk module Name.
Documentation: https://desk.zoho.com/DeskAPIDocument#Finance#Finance_Listestimates.
- [Update] action
-
Endpoint URL address:
/zohoFinance/{{=item.financeService}}/estimates/{{=item.id}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Finance#Finance_Updateinvoicestatus.
- id
A key field. Template: ShortText.
- date
Template: ShortText.
- total
Data type: DT_I4
- isViewdByClient
Data type: DT_BOOL
- totalFormatted
Template: ShortText.
- estimateNumber
Template: ShortText.
- dateFormatted
Template: ShortText.
- currencyCode
Template: ShortText.
- statusFormatted
Template: ShortText.
- financeService
A key field. Template: ShortText.
- status
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/agentAvailability.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- departmentId: Required. Specify department dentifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#agentAvailability#agentAvailability_GetCurrentAvailability.
- [Read online] action
-
Endpoint URL address:
/onlineAgents.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- departmentId: Required. Specify department dentifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#agentAvailability#agentAvailability_GetOnlineAgents.
- [Read offline] action
-
Endpoint URL address:
/offlineAgents.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- departmentId: Required. Specify department dentifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#agentAvailability#agentAvailability_GetOfflineAgents.
- [Update] action
-
Endpoint URL address:
/agentAvailabilityConfig.
The action uses POST method.Documentation: https://desk.zoho.com/DeskAPIDocument#agentAvailability#agentAvailability_UpdateAgentAvailabilityConfiguration.
- chatStatus
Template: ShortText.
- agentId
A key field. Template: ShortText.
- phoneMode
Template: ShortText.
- phoneStatus
Template: ShortText.
- mailStatus
Template: ShortText.
- presenceStatus
Template: ShortText.
- status
Template: ShortText.
- agentIdleTime
Data type: DT_I4
- treatIdleAgentsAsOffline
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/skills.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- departmentId: Required. Specify department dentifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#Skills#Skills_Listallskills.
- [Read single] action
-
Endpoint URL address:
/skills/{{=parameters.skill_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- skill_id: Required. Specify skill dentifier.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#Skills#Skills_Viewskill.
- [Read agent] action
-
Endpoint URL address:
/agents/{{=ZohoDesk.UI.AgentEditor.getValue(parameters)}}/skills.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- departmentId: Required. Specify department identifier.
- agent_id: Required. Specify agent identifier.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#Skills#Skills_GetCriteriaFieldsforSkillinaDepartment.
- [Create] action
-
Endpoint URL address:
/skills.Documentation: https://desk.zoho.com/DeskAPIDocument#Skills#Skills_Createskill.
- [Update] action
-
Endpoint URL address:
/skills/{{=item.id}}.Documentation: https://desk.zoho.com/DeskAPIDocument#Skills#Skills_Updateskill.
- [Delete] action
-
Endpoint URL address:
/skills/{{=item.id}}.
The action uses DELETE method.Documentation: https://desk.zoho.com/DeskAPIDocument#Skills#Skills_Deleteskill.
The resource includes the fields from the skillT template.
- automation_rule
A read-only field. The value is gathered from
/skills/{{=item.id}}/relatedRulesaddress. The gathered value is processed with{{=response.data}}expression. Field components:- An array.
- Contains the following components: ruleType, ruleName, ruleId.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/skillTypes.
The result is extracted from:{{=response.data}}.Documentation: https://desk.zoho.com/DeskAPIDocument#SkillTypes#SkillTypes_ListallSkillTypes.
- [Read single] action
-
Endpoint URL address:
/skillTypes/{{=parameters.skillType_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- skillType_id: Required. Specify skill type dentifier.
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
Documentation: https://desk.zoho.com/DeskAPIDocument#SkillTypes#SkillTypes_ViewSkillType.
- [Create] action
-
Endpoint URL address:
/skillTypes.Documentation: https://desk.zoho.com/DeskAPIDocument#SkillTypes#SkillTypes_CreateSkillType.
- [Update] action
-
Endpoint URL address:
/skillTypes/{{=item.id}}.Documentation: https://desk.zoho.com/DeskAPIDocument#SkillTypes#SkillTypes_UpdateaSkillType.
- [Delete] action
-
Endpoint URL address:
/skillTypes/{{=item.id}}.
The action uses DELETE method.Documentation: https://desk.zoho.com/DeskAPIDocument#SkillTypes#SkillTypes_DeleteaSkillType.
- id
A key field. Template: ShortText.
- modifiedTime
Template: DateTime. A read-only field.
- departmentId
Template: ShortText.
- description
Template: VeryLongText.
- skillTypeId
Template: ShortText.
- createdBy
Template: ShortText.
- name
Template: ShortText.
- createdTime
Template: DateTime. A read-only field.
- skillIds
Template: LongText. A composite field.
- modifiedBy
Template: ShortText.
- associatedSkills
Field components:
- An array.
-
Uses template:
associatedSkillT.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/recycleBin.
The result is extracted from:{{=response.data}}.Documentation: https://desk.zoho.com/DeskAPIDocument#RecycleBin#RecycleBin_Listdeletedresources.
- [Update] action
-
Endpoint URL address:
/recycleBin/restore.
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{={ ids: _.pluck(batch, 'id') } }}
Documentation: https://desk.zoho.com/DeskAPIDocument#RecycleBin#RecycleBin_Restoredeletedresources.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/recycleBin/delete.
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{={ ids: _.pluck(batch, 'id') } }}
Documentation: https://desk.zoho.com/DeskAPIDocument#RecycleBin#RecycleBin_DeleteresourcesfromRecycleBin.
-
application/json:
- id
A key field. Template: ShortText.
- displayName
Template: ShortText.
- departmentId
Template: ShortText.
- deletedById
Template: ShortText.
- type
Template: ShortText.
- deletedTime
Template: DateTime. A read-only field.
- isChildNeedToBeRestored
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/subjectAccessRequests.
The result is extracted from:{{=response.data}}.Documentation: https://desk.zoho.com/DeskAPIDocument#SubjectAccessRequests#SubjectAccessRequests_Listsubjectaccessrequests.
- [Read single] action
-
Endpoint URL address:
/subjectAccessRequests/{{=parameters.sar_id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- sar_id: Required. Specify subject access request dentifier.
Documentation: https://desk.zoho.com/DeskAPIDocument#SubjectAccessRequests#SubjectAccessRequests_Getsubjectaccessrequest.
- id
A key field. Template: ShortText.
- referencereferenceTicketNumber
Data type: DT_I4
- contactEmailId
Template: ShortText.
- requestType
Template: ShortText.
- recordType
Template: ShortText.
- module
Template: ShortText.
- downloadURL
Template: ShortText.
- modifiedById
Template: ShortText.
- createdBy
Template: authorT.
- referenceTicketNumber
Template: ShortText.
- sarNumber
Data type: DT_I4
- createdTime
Template: DateTime. A read-only field.
- modifiedBy
Template: authorT.
- createdById
Template: ShortText.
- status
Template: ShortText.
- query
The value is gathered from
/subjectAccessRequests/{{=item.id}}address. The gathered value is processed with{{=response.query[field.name]}}expression. Field components:- Contains the following components: criteriaFields, criteriaPattern.
- [Read] action
-
The result is paginated.The following request parameters will be automatically processed:
-
from:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}} -
_includeUserParameters:
{{=parameters}}
-
from:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Update] action
-
The action uses PATCH method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Delete] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
Based on resource template Base.
- [Read] action
-
The following request parameters will be automatically processed:
-
limit:
{{=undefined}}
-
limit:
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- VeryLongText
Data type: DT_WSTR ( length 4000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Date
Data type: DT_DBDATE
- Decimal
Data type: DT_R8
- Boolean
Data type: DT_BOOL
- Number
Data type: DT_R8
- infoT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name.
-
Uses template:
- agentT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, associatedChatDepartments, associatedDepartmentIds, lastName, extn, role, langCode, emailId, photoURL, countryCode, isConfirmed, roleId, profile, mobile, timeZone, associatedChatDepartmentIds, zuid, associatedDepartmentIds, associatedDepartments, firstName, phone, profileId, channelExpert, name, rolePermissionType, aboutInfo, status, agentIds, anonymizedName, isAnonymize.
-
Uses template:
- basicProfilePermissionT
Field components:
- Contains the following components: view, import, edit, create, delete, export, moderate, viewAllFields, overview, editAllArticles.
- teamT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, rolesWithSubordinates, departmentId, roles, name, description, derivedAgents, subTeams, agents.
-
Uses template:
- customerHappinessPerT
Field components:
- Contains the following components: badPercentage, okPercentage, goodPercentage.
- productT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, unitPrice, productCode, productName, modifiedTime, createdBy, module, status, createdTime, description, modifiedBy, departmentIds.
-
Uses template:
- customerHappinessT
Field components:
- Contains the following components: badCount, goodCount, okCount, badCount, goodCount, okCount.
- ownerT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, firstName, lastName.
-
Uses template:
- accountT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, country, modifiedTime, code, accountName, city, associatedSLAIds, accountIds, description, industry, zohoCRMAccount, ownerId, isDeleted, isTrashed, street, annualrevenue, createdTime, associate, state, sla_Id, departmentId, fax, email, status, owner, website, isFollowing, phone, webUrl, customerHappiness.
-
Uses template:
- statisticsT
Field components:
-
Uses template:
customerHappinessT. - Contains the following components: firstResponseTime, openTickets, responseTime, spamTickets, totalTickets, customerHappiness, closedTickets, resolutionTime, channelWiseCount, onholdTickets, escalatedTickets, overdueTickets.
-
Uses template:
- authorT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, photoURL, firstName, lastName, type, email, name, status, zuid.
-
Uses template:
- historyT
Field components:
-
Uses template:
ShortText. - Contains the following components: ticketNumber, statusType, subject, author, recipients, webUrl, dueDate, eventTime, priority, operation, ticketId, status.
-
Uses template:
- sourceT
Field components:
-
Uses template:
ShortText. - Contains the following components: appName, extId, type, permalink, appPhotoURL.
-
Uses template:
- contactT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, lastName, modifiedTime, country, secondaryEmail, city, description, ownerId, type, title, photoURL, twitter, isDeleted, isTrashed, street, createdTime, zohoCRMContact, customerHappiness, state, email, zip, owner, isFollowing, departmentId, facebook, mobile, accountId, status, firstName, isEndUser, isAnonymous, phone, webUrl, isSpam, associate, helpCenterId, isAccountTicketsViewable, account.
-
Uses template:
- channelRelatedInfoT
Field components:
-
Uses template:
ShortText. - Contains the following components: topicId, isTopicDeleted, forumStatus, sourceLink, topicType.
-
Uses template:
- contractT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, associatedSLAId, modifiedTime, product, productId, endDate, departmentId, notifyBefore, contractNumber, description, sla, ownerId, notificationAgentIds, contractIds, accountId, createdBy, notifyOn, createdTime, contractName, modifiedBy, startDate, account.
-
Uses template:
- associatedSkillT
Field components:
-
Uses template:
ShortText. - Contains the following components: skillName, skillId, skillTypeId.
-
Uses template:
- criteriaT
Field components:
-
Uses template:
ShortText. - Contains the following components: fieldConditions, pattern.
-
Uses template:
- skillT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, modifiedTime, agentIds, skillType, orderId, criteria, departmentId, description, skillTypeId, createdBy, name, createdTime, modifiedBy, associatedSkills, departmentId, status.
-
Uses template:
- ticketT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, modifiedTime, subCategory, sentiment, statusType, subject, dueDate, departmentId, forumId, channel, onholdTime, language, source, status, resolution, commentCount, sharedDepartments, closedTime, sharedCount, approvalCount, isOverDue, isTrashed, contact, createdTime, thread_Id, customerResponseTime, productId, contactId, threadCount, secondaryContacts, priority, classification, commentCount, taskCount, phone, webUrl, isSpam, contactSpam, handleExistingTickets, assignee, entitySkills, ticketIds, ticketNumber, isRead, description, timeEntryCount, channelRelatedInfo, isDeleted, department, followerCount, email, channelCode, isFollowing, team, assigneeId, teamId, contractId, tagCount, attachmentCount, isEscalated, category, lastThread, product, skill, uploads.
-
Uses template:
- reminderT
Field components:
-
Uses template:
LongText. - Contains the following components: alertType, reminderType, reminderTime.
-
Uses template:
- taskT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, modifiedTime, ticket, reminder, entityIds, contactId, subject, completedTime, departmentId, dueDate, creatorId, description, team, ownerId, priority, webUrl, contact, team, createdTime, modifiedBy, assignee, isSpam, category, ticketId, status.
-
Uses template:
- labelT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, preferences, isPrimary, name, helpCenterId, logoUrl, assignedTime, status, addedTime, createdTime, modifiedTime, creator, modifier.
-
Uses template:
- groupT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, addedTime, createdTime, modifiedTime, name, helpCenterId, status, logoUrl, description, creator, modifier, count.
-
Uses template:
- emailT
Field components:
-
Uses template:
ShortText. - Contains the following components: emailAddress, isVerified, isPrimary.
-
Uses template:
- userT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, lastAccessedTime, photoURL, contactId, status, userType, emailAddress, label, contact, name, label, type, email.
-
Uses template:
- timerT
Field components:
-
Uses template:
ShortText. - Contains the following components: hours, seconds, minutes, state.
-
Uses template:
- TimeSummationT
Field components:
- Contains the following components: totalMins, totalHours, totalCosts, totalSeconds.
- activeTimerT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, ticketNumber, subject, dueDate, depId, depName, status.
-
Uses template:
- translationT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, modifiedTime, createdBy, name, description, createdTime, modifiedBy, permalink, locale, categoryId.
-
Uses template:
- attachmentT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, size, name, href.
-
Uses template:
- ticketResolutionT
Field components:
-
Uses template:
DateTime. - Contains the following components: modifiedTime, author, content.
-
Uses template:
- articleResolutionT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, modifiedTime, createdBy, feedbackId, createdTime, modifiedBy, resolution, contentType.
-
Uses template:
- articleTicketT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, ticketNumber, webUrl, deletedTime, deletedBy.
-
Uses template:
- articleArticleT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, author, webUrl, locale, title.
-
Uses template:
- kbCategoryT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, modifiedTime, visibility, articleViewType, groups, logoUrl, articlePermission, description, feedbackTicketConversionPreference, associatedDepartmentIds, encryptedWorkspaceId, helpcenterId, isReviewEnabled, isTrashed, createdBy, translations, name, createdTime, modifiedBy, status, order, workspaceId, logoId, parentCategoryId, publicArticlesCount, allArticlesCount, sectionsCount, rootCategoryId, associatedDepartmentIds.
-
Uses template:
- allowedValueT
Field components:
-
Uses template:
ShortText. - Contains the following components: statusType, value.
-
Uses template:
- mappingT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, displayLabel, allowedValues.
-
Uses template:
- RuleT
Field components:
-
Uses template:
DateTime. - Contains the following components: fieldConditions, modifiedTime, fieldName, description, systemGenerated, layoutId, executeInHelpCentre, createdBy, name, createdTime, modifiedBy, status, displayLabel, name.
-
Uses template:
- ticketCountT
Field components:
-
Uses template:
Date. - Contains the following components: count, value, referenceValue.
-
Uses template:
- timeDataT
Field components:
-
Uses template:
ShortText. - Contains the following components: avgSystemTime, ticketCount, avgAgentTime, value, responseCount, referenceValue.
-
Uses template:
- CommunityUserT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, photoUrl, name, label, type, status, logoURL.
-
Uses template:
- viewT
Field components:
-
Uses template:
LongText. - Contains the following components: groupIds, permission.
-
Uses template:
- postT
Field components:
-
Uses template:
LongText. - Contains the following components: groupIds, permission.
-
Uses template:
- respondT
Field components:
-
Uses template:
LongText. - Contains the following components: groupIds, permission.
-
Uses template:
- articleT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, modifiedTime, reviewedTime, creatorId, dislikeCount, modifierId, likeCount, locale, ownerId, title, expiryDate, isTrashed, createdTime, modifiedBy, viewCount, seo, owner, summary, latestVersionStatus, myVote, author, permission, title, answer, authorId, reviewedBy, currentVersion, usageCount, commentCount, rootCategoryId, tags, ids, answer, translationId, createdBy, latestVersion, webUrl, feedbackCount, portalUrl, attachmentCount, latestPublishedVersion, category, permalink, categoryId.
-
Uses template:
- ActionT
- ArticleFeedbackT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, status, ticket, contactId, contact, createdTime, resolution, ticketId, content, article.
-
Uses template:
- ActivityT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, ticket, contactId, subject, completedTime, departmentId, dueDate, creatorId, team, contact, ownerId, priority, isCommented, webUrl, createdTime, startTime, assignee, isSpam, category, activityType, ticketId, direction, status.
-
Uses template:
- CallT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, modifiedTime, subject, completedTime, activityTime, departmentId, creatorId, statusType, description, ownerId, callId, livecall, duration, contact, createdTime, startTime, modifiedBy, direction, ticket, reminder, contactId, team, priority, webUrl, assignee, isSpam, isTrashed, isCommented, ticketId, entityIds, status.
-
Uses template:
- EventT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, modifiedTime, subject, completedTime, dueDate, departmentId, callId, creatorId, description, ownerId, secId, duration, contact, createdTime, startTime, modifiedBy, ticket, reminder, contactId, team, priority, layoutId, webUrl, teamId, assignee, isSpam, isTrashed, isCommented, category, ticketId, status.
-
Uses template:
- CustomFieldT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, displayLabel, apiName, i18NLabel, type, maxLength, decimalPlaces, roundingPrecision, roundingOption, defaultValue, allowedValues, isCustomField, toolTipType, showToHelpCenter, isEncryptedField, toolTip, isMandatory.
-
Uses template:
- TransitionT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, isAutoTransition, before, name, description, during, after, autoTransitionActions, isCommonTransition.
-
Uses template:
- CommunityTopicCommentT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, modifiedTime, creator, attachments, replies, createdTime, content, status.
-
Uses template:
- CommunityCategoryT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, isFollowing, visibility, departmentId, description, canAutoConvertTicket, commentCount, associatedDepartmentIds, photoUrl, view, post, permissions, moderation, name, deparmentIdForTicketCreation, postCount, parentCategoryId, position, followersCount, permalink, respond, moderators, status.
-
Uses template:
- CommunityTopicT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, summary, creator, latestCommentTime, subject, likeCount, label, type, latestCommenter, commentCount, createdTime, permalink, categoryId, status.
-
Uses template:
- CommunityCommentT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, summary, topicPeramlink, creator, topicId, subject, createdTime, parentCommentId, categoryId, status, topicType.
-
Uses template:
What's New
- New: Introduced connection.
Related documentation
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.