BoldDesk

Customer support help desk platform for managing tickets, live chat, contacts, and approval workflows.

8 triggers61 searches74 actionsPollingAuth: API key

AI-assisted documentation42 min read

This documentation is compiled from our integration source code, internal specs for BoldDesk, its official API documentation and anonymized requests logs we collect from our support team[2].

Open BoldDesk on WEXTL →

Requirements

To use BoldDesk on WEXTL you need an active account and an API access token from your account settings.[3]

Get your BoldDesk credentials

DomaintextRequired
Enter your domain (e.g., yourcompany.bolddesk.com).
[1]
API KeypasswordRequired
Generate your API key in BoldDesk: Go to your profile → Personal Settings → API Keys tab → Create API Key, then paste it here.
[1]

Connect BoldDesk in WEXTL

Log in to your WEXTL account, add the BoldDesk node module to your workflow, and click Create new credential.
Optional: In the Credential name field, enter a name for the credential.
Enter the authentication credentials you copied from your BoldDesk account, or follow the on-screen instructions to create the credential.
If prompted, authenticate your account and confirm access.
If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Connecting BoldDesk to WEXTL® — Video slide demonstrates how to integrate BoldDesk in the WEXTL visual workflow builder.[4]

Video slide demonstrates how to integrate BoldDesk in the WEXTL visual workflow builder.[4]

Notes

Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →

BoldDesk node modules

The list below is a reference of every BoldDesk node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.

Open any BoldDesk node module below to inspect its input parameters, outputs, and connection requirements.

Watch ActivityTrigger

Output fields[3]

Field	Type
Activity ID	number
Activity subject	text
Activity description	text
Created by	object
Phone number	text
Mobile number	text
Agent shift ID	number
Agent shift name	text
Ticket limit	number
Chat limit	number
Email ID	text
Short code	text
Color code	text
Status	text
Created on	text
Modified by	object
Agent shift ID	number
Agent shift name	text
Ticket limit	number
Chat limit	number
Email ID	text
Short code	text
Color code	text
Status	text
Is verified	boolean
Profile image URL	url
Modified on	date
Activity status	object
Status category	text
Description	text
Text color	text
Background color	text
ID	number

35other output fields

Watch Activity AttachmentTrigger

Output fields[3]

Field	Type
ID	number
Name	text
Extension	text
Content type	text
Size	number
Created on	date
File URL	text
Cloud storage type	text

3other output fields

Watch Activity CommentsTrigger

Output fields[3]

Field	Type
Comment ID	number
Description	text
Update flag name	text
Update flag ID	number
Source	text
Created by	object
Agent shift ID	number
Agent shift name	text
Ticket limit	number
Chat limit	number
Email ID	text
Short code	text
Color code	text
Status	text
Is verified	boolean
Profile image URL	url
Modified by	object
Agent shift ID	number
Agent shift name	text
Ticket limit	number
Chat limit	number
Email ID	text
Short code	text
Color code	text
Status	text
Is verified	boolean
Profile image URL	url
Created on	date

3other output fields

Watch Approval RequestsTrigger

Output fields[3]

Field	Type
Approval ID	text
Ticket ID	number
Ticket title	text
Ticket status	object
Status ID	number
Description	text
Text color	text
Background color	text
ID	number
Approval request ID	number
Approval title	text
Description	text
Approval request status	object
Status ID	number
Description	text
Text color	text
Background color	text
ID	number

12other output fields

Watch ConversationsTrigger

Output fields[3]

Field	Type
IP address	text
Browser details	text
City	text
Country	text
Custom details	text
Agent	object
Status	text
Is ai agent	text
ID	number
Guid	text
Name	text
Display name	text
Email	text
Short code	text
Color code	text
Profile image URL	text
Language	object
ID	number
Name	text
Priority	object
ID	number
Name	text
Background color	text
Sort order	number

27other output fields

Watch MessagesTrigger

Output fields[3]

Field	Type
Message ID	text
Conversation ID	text
Author	object
User ID	number
Visitor ID	text
Is user	boolean
From	text
Is private	boolean
Created on	date
Message content	object
Message	text
Text format	text
Attachments	text
Catalog items	text
Fields	text
Form message ID	text
Response fields	text

Watch TicketTrigger

Output fields[3]

Field	Type
Ticket ID	number
Title	text
Agent	object
Name	text
ID	number
Group	object
Name	text
ID	number
Category	object
ID	number
Name	text
Status	object
Description	text
Text color	text
Background color	text
ID	number
Priority	object
Description	text
Text color	text
Background color	text
ID	number
Brand	text

10other output fields

Watch Ticket UpdatesTrigger

Output fields[3]

Field	Type
Is first update	boolean
Is updated by customer	boolean
ID	number
Description	text
Has attachment	boolean
Attachments	array
Created on	date
Updated on	date

6other output fields

Get a ContactAction

Input fields[3]

Field	Type
User IDRequired	choice

Output fields[3]

Field	Type
User ID	number
Contact display name	text
Contact name	text
Email ID	text
Secondary email ID	text
Status	text
Last activity on	date
Is verified	boolean

26other output fields

Get a GroupAction

Input fields[3]

Field	Type
Group IDRequired	choice

Output fields[3]

Field	Type
Group name	text
Group ID	number
Group module ID	number
Group module name	text
Description	text
Short code	text
Color code	text
Business hours	text

Get a MessageAction

Input fields[3]

Field	Type
Conversation IDRequired	choice

Output fields[3]

Field	Type
Message ID	text
Conversation ID	text
Author	object
User ID	number
Visitor ID	text
Is user	boolean
From	text
Is private	boolean
Created on	text
Message content	object
Message	text
Text format	text
Attachments	text
Catalog items	text
Fields	text
Form message ID	text
Response fields	text

Get a VisitorAction

Input fields[3]

Field	Type
Visitor IDRequired	choice

Output fields[3]

Field	Type
Timezone	text
Language	object
ID	number
Name	text
Linked user	object
Agent shift ID	number
Agent shift name	text
Ticket limit	number
Chat limit	number
Email ID	text
Short code	text
Color code	text
Status	text
Is verified	boolean
Profile image URL	url
Last conversation on	date
Last modified on	date
Originated from brand	object
ID	number
Name	text
ID	text
Name	text

13other output fields

Get Activity TagsSearch

Input fields[3]

Field	Type
Activity IDRequired	choice

Output fields[3]

Field	Type
Tag ID	number
Name	text

Get Agent By EmailAction

Input fields[3]

Field	Type
Email AddressRequired	text

Output fields[3]

Field	Type
Is available	boolean
Contact name	text
Contact display name	text
Contact phone no	text
Contact tag	text
Contact mobile no	text
Contact address	text
Contact job title	text

39other output fields

Get Agent By Group IdSearch

Input fields[3]

Field	Type
Filter	text
Include Total Count	boolean
Order By	choice
Group ID	choice
Role	choice
Shift ID	text
Agent User ID	choice
Limit	number

Output fields[3]

Field	Type
Agent shift ID	number
Agent shift name	text
Ticket limit	number
Chat limit	number
Email ID	text
Short code	text
Color code	text
Status	text

8other output fields

Get an Activity DetailAction

Input fields[3]

Field	Type
Activity IDRequired	choice

Output fields[3]

Field	Type
Activity ID	number
Activity subject	text
Activity description	text
Created by	object
Phone number	text
Mobile number	text
Agent shift ID	number
Agent shift name	text
Ticket limit	number
Chat limit	number
Email ID	text
Short code	text
Color code	text
Status	text
Created on	text
Modified by	object
Agent shift ID	number
Agent shift name	text
Ticket limit	number
Chat limit	number
Email ID	text
Short code	text
Color code	text
Status	text
Is verified	boolean
Profile image URL	url
Modified on	date
Activity status	object
Status category	text
Description	text
Text color	text
Background color	text
ID	number

35other output fields

Get an AgentAction

Input fields[3]

Field	Type
Agent User IDRequired	choice

Output fields[3]

Field	Type
Is available	boolean
Contact name	text
Contact display name	text
Contact phone no	text
Contact tag	text
Contact mobile no	text
Contact address	text
Contact job title	text

39other output fields

Get Contact by EmailAction

Input fields[3]

Field	Type
EmailRequired	choice

Output fields[3]

Field	Type
User ID	number
Contact display name	text
Contact name	text
Email ID	text
Secondary email ID	text
Status	text
Last activity on	text
Is verified	boolean

26other output fields

Get Contact FieldAction

Input fields[3]

Field	Type
Contact Field IDRequired	choice

Output fields[3]

Field	Type
Can edit in agent portal	boolean
Is mandatory for submitting form in agent portal	boolean
Is visible in customer portal	boolean
Can edit in customer portal	boolean
Is mandatory for submitting form in customer portal	boolean
Is visible on sign up	boolean
Field group ID	number
Field ID	number

26other output fields

Get Conversation DetailsAction

Input fields[3]

Field	Type
Conversation IDRequired	choice

Output fields[3]

Field	Type
Agent	object
ID	number
Guid	text
Name	text
Display name	text
Email	text
Short code	text
Color code	text
Profile image URL	text
Priority	object
ID	number
Name	text
Last modified on	date
Created on	date
Status sort order	number
Priority sort order	number
Source sort order	number
Language	object
ID	number
Name	text

14other output fields

Get Conversation ParticipantAction

Input fields[3]

Field	Type
Conversation IDRequired	choice

Output fields[3]

Field	Type
Short code	text
Color code	text
Display name	text
Name	text
Email ID	text
User ID	number
Is verified	boolean

Get Conversation TagsAction

Input fields[3]

Field	Type
Conversation IDRequired	choice

Output fields[3]

Field	Type
Tag ID	number
Name	text

Get Request Details By IDAction

Input fields[3]

Field	Type
Approval IDRequired	choice

Output fields[3]

Field	Type
Ticket ID	number
Ticket title	text
Ticket status	object
Status ID	number
Description	text
Text color	text
Background color	text
ID	number
Approval request ID	number
Title	text
Description	text
Status	object
Status ID	number
Description	text
Text color	text
Background color	text
ID	number
Type	object
ID	number
Name	text

13other output fields

Get Ticket DetailsAction

Input fields[3]

Field	Type
Ticket IDRequired	choice

Output fields[3]

Field	Type
Ticket ID	number
Title	text
Agent	object
Name	text
ID	number
Group	object
Name	text
ID	number
Category	object
ID	number
Name	text
Status	object
Description	text
Text color	text
Background color	text
ID	number
Priority	object
Description	text
Text color	text
Background color	text
ID	number
Brand	text

10other output fields

Get Ticket TagAction

Input fields[3]

Field	Type
Ticket IDRequired	choice

Output fields[3]

Field	Type
Tag ID	number
Name	text

Get Ticket WatchersAction

Input fields[3]

Field	Type
Ticket IDRequired	choice

Output fields[3]

Field	Type
Message	text

Get User by EmailAction

Input fields[3]

Field	Type
EmailRequired	email

Output fields[3]

Field	Type
User details	object
Agent shift ID	number
Agent shift name	text
Ticket limit	number
Chat limit	number
Email ID	text
Short code	text
Color code	text
Status	text
Is verified	boolean
Profile image URL	text
Name	text
Phone	text
Address	text
Time zone name	text
Contact group	array
Time zone iana name	text
Mobile	text

3other output fields

Get User by IDAction

Input fields[3]

Field	Type
User IDRequired	text

Output fields[3]

Field	Type
User details	object
Agent shift ID	number
Agent shift name	text
Ticket limit	number
Chat limit	number
Email ID	text
Short code	text
Color code	text
Status	text
Is verified	boolean
Profile image URL	text
Name	text
Phone	text
Address	text
Time zone name	text
Contact group	array
Time zone iana name	text
Mobile	text

3other output fields

List ActivitySearch

Input fields[3]

Field	Type
Ticket ID	choice
Statuses	array
Status ID	number
Types	array
Type ID	number
Search Text	text
View ID	number
User ID	choice
Contact Group ID	choice
Advanced Filters	text

4other input fields

Output fields[3]

Field	Type
Activity ID	number
Activity subject	text
Activity description	text
Created by	object
Phone number	text
Mobile number	text
Agent shift ID	number
Agent shift name	text
Ticket limit	number
Chat limit	number
Email ID	text
Short code	text
Color code	text
Status	text
Created on	text
Modified by	object
Agent shift ID	number
Agent shift name	text
Ticket limit	number
Chat limit	number
Email ID	text
Short code	text
Color code	text
Status	text
Is verified	boolean
Profile image URL	url
Modified on	date
Activity status	object
Status category	text
Description	text
Text color	text
Background color	text
ID	number

35other output fields

List Activity AttachmentsSearch

Input fields[3]

Field	Type
Activity IDRequired	choice
Include Total Count	boolean
Order By	choice
Limit	number

Output fields[3]

Field	Type
ID	number
Name	text
Extension	text
Content type	text
Size	number
Created on	date
File URL	text
Cloud storage type	text

3other output fields

List Activity CommentSearch

Input fields[3]

Field	Type
Activity IDRequired	choice
Filter	text
Include Total Count	boolean
Order By	choice
Limit	number

Output fields[3]

Field	Type
Comment ID	number
Description	text
Update flag name	text
Update flag ID	number
Source	text
Created by	object
Agent shift ID	number
Agent shift name	text
Ticket limit	number
Chat limit	number
Email ID	text
Short code	text
Color code	text
Status	text
Is verified	boolean
Profile image URL	url
Modified by	object
Agent shift ID	number
Agent shift name	text
Ticket limit	number
Chat limit	number
Email ID	text
Short code	text
Color code	text
Status	text
Is verified	boolean
Profile image URL	url
Created on	date

3other output fields

List Activity StatusSearch

Input fields[3]

Field	Type
Filter	text
Include Total Count	boolean
Order By	choice
Limit	number

Output fields[3]

Field	Type
ID	number
Name	text
Color code	text
Status category	object
ID	number
Name	text

List Activity TypesSearch

Input fields[3]

Field	Type
Filter	text
Include Total Count	boolean
Order By	choice
Limit	number

Output fields[3]

Field	Type
Activity Type ID	number
Name	text

List Activity WatchersSearch

Input fields[3]

Field	Type
Activity IDRequired	choice
Limit	number

Output fields[3]

Field	Type
Agent shift ID	number
Agent shift name	text
Ticket limit	number
Chat limit	number
Email ID	text
Short code	text
Color code	text
Status	text

8other output fields

List Agent and Group CollectionsSearch

Input fields[3]

Field	Type
Filter	text
Search Type	choice
Exclude Agent IDs	choice
Exclude Group IDs	choice
Include Agent IDs	choice
Include Group IDs	choice
Limit	number

Output fields[3]

Field	Type
Agent ID	number
Name	text
Email ID	text
Color code	text
Short code	text
Is agent	boolean
Category name	text

List AgentsSearch

Input fields[3]

Field	Type
User Status	number
Is Available	boolean
Role	choice
Verified Agents Only	boolean
Agent Tags	text
Copilot Assigned	boolean
Advanced Filters	text
Filter	text

3other input fields

Output fields[3]

Field	Type
Is available	boolean
Name	text
Display name	text
User ID	number
Email ID	text
Roles	array
Status	text
Last activity on	text

13other output fields

List Agents and CustomersSearch

Input fields[3]

Field	Type
Filter	text
Order By	choice
Include Total Count	boolean
Only Customers	boolean
Only Email Users	boolean
Limit	number

Output fields[3]

Field	Type
Agent shift ID	number
Agent shift name	text
Ticket limit	number
Chat limit	number
Email ID	text
Short code	text
Color code	text
Status	text

8other output fields

List Approval Request ListSearch

Input fields[3]

Field	Type
Ticket ID	number
Statuses	array
Status ID	number
Types	array
Type ID	number
Advanced Filters	text
View	choice
Search Text	text
Include Total Count	boolean
Order By	choice

1other input field

Output fields[3]

Field	Type
Approval ID	text
Ticket ID	number
Ticket title	text
Ticket status	object
Status ID	number
Description	text
Text color	text
Background color	text
ID	number
Approval request ID	number
Approval title	text
Description	text
Approval request status	object
Status ID	number
Description	text
Text color	text
Background color	text
ID	number

12other output fields

List Approval Request Status CollectionSearch

Input fields[3]

Field	Type
Filter	text
Include Total Count	boolean
Order By	choice
Limit	number

Output fields[3]

Field	Type
Approval request status list	array
Total list count	number

List Contact FieldsSearch

Input fields[3]

Field	Type
Search	text
Limit	number

Output fields[3]

Field	Type
Field ID	number
API name	text
Label for agent portal	text
Label for customer portal	text
Is default system field	boolean
Is active	boolean
Is visible in customer portal	boolean
Field type	text

6other output fields

List Contact Groups by ContactSearch

Input fields[3]

Field	Type
Contact IDRequired	choice
Search	text
Sort By	choice
Include Total Count	boolean
Limit	number

Output fields[3]

Field	Type
ID	number
Name	text
Access scope ID	number
Is primary	boolean

List Contact NotesSearch

Input fields[3]

Field	Type
Contact IDRequired	choice
Order By	choice
Include Total Count	boolean
Limit	number

Output fields[3]

Field	Type
Contact Note ID	number
Subject	text
Description	text
Has attachment	boolean
Created on	date
Updated on	date
Created by	object
Agent shift ID	number
Agent shift name	text
Ticket limit	number
Chat limit	number
Email ID	text
Short code	text
Color code	text
Status	text
Is verified	boolean
Profile image URL	url
Is edited	boolean

1other output field

List ContactsSearch

Input fields[3]

Field	Type
Search	text
Advanced Filters	text
Sort By	choice
Include Total Count	boolean
View	text
Limit	number

Output fields[3]

Field	Type
Contact external reference ID	text
Contact address	text
Contact custom fields	object
Cf contact custom name	text
Cf contact additional info	text
Cf contact custom checkbox	text
Cf contact custom yesno	text
Cf contact date	text
Cf contact datetime	text
Cf customer countries	text
Cf contact secondary email	text
Cf contact web link	text
Cf customer region	text
User ID	number
Contact name	text
Contact display name	text
Email ID	text
Is verified	boolean

13other output fields

List Conversation PrioritiesSearch

Input fields[3]

Field	Type
Filter	text
Limit	number

Output fields[3]

Field	Type
User ID	number
Email address	email
Name	text
Date created	date

List Conversation StatusesSearch

Input fields[3]

Field	Type
Filter	text
Exclusion IDs	array
Status ID	number
Status Category IDs	array
Status Category ID	number
Brand ID	choice
Limit	number

Output fields[3]

Field	Type
Status category	object
ID	number
Name	text
Field option ID	number
Sort order	number
ID	number
Name	text
Background color	text

List Conversation Ticket LinkSearch

Input fields[3]

Field	Type
Conversation IDRequired	choice
Include Total Count	boolean
Order By	text
Limit	number

Output fields[3]

Field	Type
ID	text
Chat conversation guid	text
Ticket details	object
ID	number
Title	text
Status	object
Is visible in customer portal	boolean
Customer portal ticket URL	text
Status	text
Source	text
Agent	text

List ConversationsSearch

Input fields[3]

Field	Type
Filter ID	text
Fields	array
Field	text
Brand IDs	choice
Filter	text
Include Total Count	boolean
Order By	choice
Limit	number

Output fields[3]

Field	Type
IP address	text
Browser details	text
City	text
Country	text
Custom details	text
Agent	object
Status	text
Is ai agent	text
ID	number
Guid	text
Name	text
Display name	text
Email	text
Short code	text
Color code	text
Profile image URL	text
Language	object
ID	number
Name	text
Priority	object
ID	number
Name	text
Background color	text
Sort order	number

27other output fields

List Deleted TicketsSearch

Input fields[3]

Field	Type
Include Total Count	boolean
Order By	choice
Last Ticket Changed From	date
Last Ticket Changed To	date
Brand IDs	choice
Limit	number

Output fields[3]

Field	Type
Ticket ID	number
Title	text
Category	object
ID	number
Name	text
Created on	date
Status	object
Description	text
Text color	text
Background color	text
ID	number
Requested by	object
Agent shift ID	number
Agent shift name	text
Ticket limit	number
Chat limit	number
Email ID	text
Short code	text
Color code	text
Status	text
Is verified	boolean
Profile image URL	url
Last modified on	date
Last ticket state changed on	date

1other output field

List Group CollectionsSearch

Input fields[3]

Field	Type
Group Module	choice
Filter	text
Include Total Count	boolean
Order By	choice
Include Additional Group IDs	text
Limit	number

Output fields[3]

Field	Type
Group name	text
Group ID	number
Group module ID	number
Group module name	text

List GroupsSearch

Input fields[3]

Field	Type
Group Module	choice
Filter	text
Include Total Count	boolean
Order By	choice
Limit	number

Output fields[3]

Field	Type
Group name	text
Group ID	number
Group module ID	number
Group module name	text
Description	text
Short code	text
Color code	text
Business hours	text

List Members By Group IdSearch

Input fields[3]

Field	Type
Group IDRequired	choice
Filter	text
Include Total Count	boolean
Order By	choice
Limit	number

Output fields[3]

Field	Type
Short code	text
Color code	text
Name	text
Display name	text
User ID	number
Is agent	boolean
Email ID	text
Can participate in ticket auto assignment	boolean

2other output fields

List MessagesSearch

Input fields[3]

Field	Type
Conversation IDRequired	choice
Include Total Count	boolean
Order By	text
Limit	number

Output fields[3]

Field	Type
Message ID	text
Conversation ID	text
Author	object
User ID	number
Visitor ID	text
Is user	boolean
From	text
Is private	boolean
Created on	date
Message content	object
Message	text
Text format	text
Attachments	text
Catalog items	text
Fields	text
Form message ID	text
Response fields	text

List Spam ConversationsSearch

Input fields[3]

Field	Type
Brand IDs	choice
Include Total Count	boolean
Order By	text
Limit	number

Output fields[3]

Field	Type
Agent	object
ID	number
Guid	text
Name	text
Display name	text
Email	text
Short code	text
Color code	text
Profile image URL	text
Priority	object
ID	number
Name	text
Last modified on	date
Created on	date
Status sort order	number
Priority sort order	number
Source sort order	number
Language	object
ID	number
Name	text

14other output fields

List Spam TicketsSearch

Input fields[3]

Field	Type
Include Total Count	boolean
Order By	choice
Last Ticket Changed From	date
Last Ticket Changed To	date
Brand IDs	choice
Limit	number

Output fields[3]

Field	Type
Ticket ID	number
Title	text
Category	object
ID	number
Name	text
Created on	text
Status	object
Description	text
Text color	text
Background color	text
ID	number
Requested by	object
Agent shift ID	number
Agent shift name	text
Ticket limit	number
Chat limit	number
Email ID	text
Short code	text
Color code	text
Status	text
Is verified	boolean
Profile image URL	url
Last modified on	date
Last ticket state changed on	date

1other output field

List Ticket AttachmentsSearch

Input fields[3]

Field	Type
Ticket IDRequired	choice
Include Total Count	boolean
Order By	choice
Limit	number

Output fields[3]

Field	Type
Update ID	number
Is file attached in private note	boolean
ID	number
Name	text
Extension	text
Content type	text
Size	number
Created on	date

5other output fields

List Ticket FieldsSearch

Input fields[3]

Field	Type
Filter	text
Limit	number

Output fields[3]

Field	Type
Field ID	number
API name	text
Label for agent portal	text
Label for customer portal	text
Is default system field	boolean
Is active	boolean
Is visible in customer portal	boolean
Field type	text

3other output fields

List Ticket FormsSearch

Input fields[3]

Field	Type
Brand IDRequired	choice
Filter	text
Include Total Count	boolean
Order By	text
Limit	number

Output fields[3]

Field	Type
Field ID	number
API name	text
Label for agent portal	text
Label for customer portal	text
Is default system field	boolean
Is active	boolean
Is visible in customer portal	boolean
Field type	text

3other output fields

List Ticket HistoriesSearch

Input fields[3]

Field	Type
Ticket IDRequired	choice
Include Total Count	boolean
Order By	choice
Limit	number

Output fields[3]

Field	Type
Transaction ID	number
Change logs	array
Automation	object
ID	number
Name	text
Automation type	text
Automation type ID	number
Is sla rule removed	boolean
Updated on	text
Updated by	object
Agent shift ID	number
Agent shift name	text
Ticket limit	number
Chat limit	number
Email ID	text
Short code	text
Color code	text
Status	text
Is verified	boolean
Profile image URL	text
Type	object
Name	text
Description	text
Color code	text
Macros	text
Ai agent	object
ID	number
Name	text

1other output field

List Ticket Metric ListsSearch

Input fields[3]

Field	Type
Advanced Filters	text
Include Total Count	boolean
Order By	choice
Limit	number

Output fields[3]

Field	Type
Ticket metric ID	number
Ticket ID	number
Org ID	number
Resolved on	text
Resolution time	number
Closure time	number
Reopen count	number
Assigned group count	number

33other output fields

List Ticket NotesSearch

Input fields[3]

Field	Type
Ticket IDRequired	choice
Include Total Count	boolean
Order By	choice
Message Tag IDs	array
Message Tag ID	number
Limit	number

Output fields[3]

Field	Type
Notes type	text
ID	number
Description	text
Has attachment	boolean
Attachments	array
Created on	date
Updated on	date
Updated by	object
Agent shift ID	number
Agent shift name	text
Ticket limit	number
Chat limit	number
Email ID	text
Short code	text
Color code	text
Status	text
Is verified	boolean
Profile image URL	url

5other output fields

List Ticket PrioritiesSearch

Input fields[3]

Field	Type
Filter	text
Limit	number

Output fields[3]

Field	Type
ID	number
Name	text

List Ticket SourcesSearch

Input fields[3]

Field	Type
Filter	text
Limit	number

Output fields[3]

Field	Type
ID	number
Name	text

List Ticket StatusesSearch

Input fields[3]

Field	Type
Filter	text
Limit	number

Output fields[3]

Field	Type
Ticket ID	number
Name	text
Color code	text
Status category	object
ID	number
Name	text
Field option ID	text

List Ticket Update ListSearch

Input fields[3]

Field	Type
Advanced Filters	text
Include Total Count	boolean
Order By	choice
Include Deleted Updates	boolean
Limit	number

Output fields[3]

Field	Type
Is first update	boolean
Is updated by customer	boolean
Ticket update ID	number
Ticket ID	number
Description	text
Created on	date
Updated on	date
Updated by	object
Email ID	text
Short code	text
Color code	text
Status	text
Is verified	boolean
Profile image URL	text
Is phone no verified	boolean
Phone no	text
User ID	number
Name	text

4other output fields

List Ticket UpdatesSearch

Input fields[3]

Field	Type
Ticket IDRequired	choice
Include Total Count	boolean
Order By	choice
Message Tag IDs	array
Message Tag ID	number
Include First Update	boolean
Attachments Count	number
Limit	number

Output fields[3]

Field	Type
Is first update	boolean
Is updated by customer	boolean
ID	number
Description	text
Has attachment	boolean
Attachments	array
Created on	date
Updated on	date

6other output fields

List Ticket WorklogsSearch

Input fields[3]

Field	Type
Ticket IDRequired	choice
Include Total Count	boolean
Order By	choice
Limit	number

Output fields[3]

Field	Type
Worklog ID	number
Time spent	number
Is billable	boolean
Worklog date	date
Description	text
Created by	object
Agent shift ID	number
Agent shift name	text
Ticket limit	number
Chat limit	number
Email ID	text
Short code	text
Color code	text
Status	text
Is verified	boolean
Profile image URL	url
Created on	text
Updated by	object
Agent shift ID	number
Agent shift name	text
Ticket limit	number
Chat limit	number
Email ID	text
Short code	text
Color code	text
Status	text
Is verified	boolean
Profile image URL	url

1other output field

List TicketsSearch

Input fields[3]

Field	Type
Advanced Filters	text
Filter ID	text
Fields	array
Field	choice
Brand IDs	choice
Include Total Count	boolean
Order By	choice
Limit	number

Output fields[3]

Field	Type
Ticket ID	number
Title	text
Agent	object
Name	text
ID	number
Group	object
Name	text
ID	number
Category	object
ID	number
Name	text
Status	object
Description	text
Text color	text
Background color	text
ID	number
Priority	object
Description	text
Text color	text
Background color	text
ID	number
Brand	text

10other output fields

List User Contact GroupsSearch

Input fields[3]

Field	Type
User IDRequired	choice
Filter	text
Limit	number

Output fields[3]

Field	Type
User ID	number
Name	text
Is primary	boolean

List VisitorsSearch

Input fields[3]

Field	Type
Status ID	text
Is Verified	boolean
Source ID	text
Country ID	text
Filter	text
Include Total Count	boolean
Order By	text
Limit	number

Output fields[3]

Field	Type
Visitor ID	text
Name	text
User name	text
Email	email
Phone	text
Country	text
Division	text
City	text

7other output fields

Activate AgentAction

Input fields[3]

Field	Type
Agent User IDRequired	choice

Output fields[3]

Field	Type
Message	text

Add Activity Attachment To An ActivityAction

Input fields[3]

Field	Type
Activity IDRequired	choice
Upload FilesRequired	text

Output fields[3]

Field	Type
Data	text

Add Contact Groups to ContactAction

Input fields[3]

Field	Type
Contact IDRequired	choice
Contact Groups	array

Output fields[3]

Field	Type
Contact group ID	number
Is success	boolean
Reason	text

Add Member To GroupAction

Input fields[3]

Field	Type
Group IDRequired	choice
MembersRequired	array
Member	object

Output fields[3]

Field	Type
Result	object
ID	number
Is success	boolean
Reason	text
Message	text

Add Tags To TicketAction

Input fields[3]

Field	Type
Ticket IDRequired	choice
TagsRequired	array
Tag	text

Output fields[3]

Field	Type
Message	text

Approve an ApproverAction

Input fields[3]

Field	Type
Approval IDRequired	choice
Comment	text
Attachments	array
Attachment Token	text
Approval Reason ID	number

Output fields[3]

Field	Type
Message	text

Block a ContactAction

Input fields[3]

Field	Type
Contact IDRequired	choice
Mark Tickets as Spam	boolean

Output fields[3]

Field	Type
Message	text

Cancel an ApproverAction

Input fields[3]

Field	Type
Approval IDRequired	choice
Approver GUIDRequired	text
Comment	text
Attachments	array
Attachment Token	text
Approval Reason ID	number

Output fields[3]

Field	Type
Message	text

Change Primary Contact GroupAction

Input fields[3]

Field	Type
Contact IDRequired	choice

Output fields[3]

Field	Type
Message	text

Convert Contact to AgentAction

Input fields[3]

Field	Type
User IDRequired	choice
NameRequired	text
Skip Validation	boolean
Display Name	text
Time Zone ID	choice
All Brand Access	boolean
Brand IDs	choice
Role IDsRequired	choice

14other input fields

Output fields[3]

Field	Type
Name	text
Display name	text
Time zone ID	number
Has all brand access	boolean
Brand ids	text
Role ids	text
Ticket access scope ID	number
Agent phone no	text

12other output fields

Create a ContactAction

Input fields[3]

Field	Type
Contact NameRequired	text
EmailRequired	choice
Secondary Email	choice
Display Name	text
Phone Number	text
Mobile Number	text
Address	text
Job Title	text

10other input fields

Output fields[3]

Field	Type
Contact ID	number
Message	text

Create a Contact NoteAction

Input fields[3]

Field	Type
Contact IDRequired	choice
Subject	text
DescriptionRequired	text
Attachments	text

Output fields[3]

Field	Type
Contact Note ID	number
Message	text

Create a GroupAction

Input fields[3]

Field	Type
Group NameRequired	text
Description	text
Group ModuleRequired	choice
Business Hour ID	choice

Output fields[3]

Field	Type
Group ID	number
Message	text
Short code	text
Color code	text

Create a TicketAction

Input fields[3]

Field	Type
Brand IDRequired	choice
SubjectRequired	text
Category ID	number
Status ID	number
Visible In Customer Portal	boolean
Requester ID	text
DescriptionRequired	text
Agent ID	choice

26other input fields

Output fields[3]

Field	Type
Ticket ID	number
Is file upload success	boolean

Create a Ticket NoteAction

Input fields[3]

Field	Type
Ticket IDRequired	choice
Note DescriptionRequired	text
Public Note	boolean
Attachments	array
Attachment Token	text
Mentioned Users	array
User ID	number
Last Update ID	number
Last Refresh Date	date
Time Spent	number

8other input fields

Output fields[3]

Field	Type
Description	text
At mentioned user ids	array
Last update ID	number
Last refresh date	text
Time spent	text
Message tags	text
Updated byuser idor email ID	text
Skip email notification	boolean

6other output fields

Create Activity CommentAction

Input fields[3]

Field	Type
Activity IDRequired	choice
DescriptionRequired	text
Attachments	array
Attachment Token	text
Activity Status ID	number
Mentioned User IDs	array
Mentioned User ID	number

Output fields[3]

Field	Type
Activity ID	number
Message	text

Create Activity WatcherAction

Input fields[3]

Field	Type
Activity IDRequired	choice

Output fields[3]

Field	Type
Message	text

Create an ActivityAction

Input fields[3]

Field	Type
Activity SubjectRequired	text
Activity Description	text
Activity TypeRequired	number
Skip Dependency Validation	boolean
Activity Priority	number
Activity StatusRequired	number
Activity Agent	number
Linked Ticket	number

16other input fields

Output fields[3]

Field	Type
Activity ID	number
Message	text

Create an Activity AttactmentAction

Input fields[3]

Field	Type
Upload FilesRequired	text

Output fields[3]

Field	Type
Data	text

Create an AgentAction

Input fields[3]

Field	Type
EmailRequired	choice
Agent Name	text
Display Name	text
Time Zone ID	choice
Has All Brand Access	boolean
Brand IDs	choice
Role IDs	choice
Ticket Access Scope ID	number

29other input fields

Output fields[3]

Field	Type
Agent ID	number
Message	text

Create an Approval RequestAction

Input fields[3]

Field	Type
Ticket ID	choice
SubjectRequired	text
Description	text
Approval Request Type IDRequired	number
ApproversRequired	array
User ID	choice
Attachments	array
Attachment Token	text
Time Spent	number
Is Billable	boolean

2other input fields

Output fields[3]

Field	Type
Approval ID	number
Message	text

Create an AttachmentAction

Input fields[3]

Field	Type
Attachment FileRequired	text

Output fields[3]

Field	Type
Token	text
URL	url

Create And Link A ContactAction

Input fields[3]

Field	Type
Visitor IDRequired	choice
Name	text
Email Address	text
Contact Group ID	choice
Phone Number	text
Send Email Notification	boolean

Output fields[3]

Field	Type
ID	number
Message	text

Create Chat AttachmentsAction

Input fields[3]

Field	Type
FileRequired	text
Conversation IDRequired	text
Private Attachment	boolean
Inline Attachment	boolean

Output fields[3]

Field	Type
Token	text
URL	url

Create Conversation Ticket LinkAction

Input fields[3]

Field	Type
Conversation IDRequired	choice

Output fields[3]

Field	Type
Message	text

Create New ApproverAction

Input fields[3]

Field	Type
Approval IDRequired	choice
ApproversRequired	array
User ID	choice

Output fields[3]

Field	Type
Message	text

Create Ticket WatcherAction

Input fields[3]

Field	Type
Ticket IDRequired	choice

Output fields[3]

Field	Type
Message	text

Create Ticket WorklogAction

Input fields[3]

Field	Type
Ticket IDRequired	choice
Description	text
Time Spent	number
Is BillableRequired	boolean
Time Log Date	date
Time Log Type ID	number

Output fields[3]

Field	Type
Message	text

Deactivate an AgentAction

Input fields[3]

Field	Type
Agent User IDRequired	choice
New Ticket Agent	choice
New Ticket Group	choice
Reassign Tickets or Chats	boolean
Remove Agent Only	boolean
Integration App ID	number
New Chat Agent	choice
New Chat Group	choice

Output fields[3]

Field	Type
Message	text

Delete a ContactAction

Input fields[3]

Field	Type
Contact IDsRequired	choice
Mark Tickets as Spam	boolean
Integration App ID	number
Modified User ID	number

Output fields[3]

Field	Type
ID	number
Is success	boolean

Delete a MessageAction

Input fields[3]

Field	Type
Conversation IDRequired	text
Message IDRequired	text

Output fields[3]

Field	Type
Message	text

Delete a Ticket WorklogAction

Input fields[3]

Field	Type
Ticket IDRequired	choice

Output fields[3]

Field	Type
Message	text

Delete Activity WatcherAction

Input fields[3]

Field	Type
Activity IDRequired	choice

Output fields[3]

Field	Type
Message	text

Delete an ActivityAction

Input fields[3]

Field	Type
Activity IDRequired	choice

Output fields[3]

Field	Type
Message	text

Delete an Activity AttachmentAction

Input fields[3]

Field	Type
Activity IDRequired	choice

Delete an Activity CommentAction

Input fields[3]

Field	Type
Activity IDRequired	choice

Output fields[3]

Field	Type
Message	text

Delete an Approval RequestAction

Input fields[3]

Field	Type
Approval IDRequired	choice

Output fields[3]

Field	Type
Message	text

Delete AttachmentAction

Input fields[3]

Field	Type
Attachment IDRequired	number

Output fields[3]

Field	Type
Message	text

Delete Contact Groups from ContactAction

Input fields[3]

Field	Type
Contact IDRequired	choice
Contact Group IDsRequired	choice

Output fields[3]

Field	Type
ID	number
Is success	boolean
Reason	text

Delete Contact NoteAction

Input fields[3]

Field	Type
Note IDRequired	number

Output fields[3]

Field	Type
Message	text

Delete Conversations PermanentlyAction

Input fields[3]

Field	Type
Conversation IDRequired	text

Output fields[3]

Field	Type
Message	text

Delete GroupAction

Input fields[3]

Field	Type
Group IDRequired	choice

Output fields[3]

Field	Type
Result	text

Delete Member From GroupAction

Input fields[3]

Field	Type
Group IDRequired	choice
User IDRequired	number

Output fields[3]

Field	Type
Result	text

Delete TicketAction

Input fields[3]

Field	Type
Ticket IDRequired	choice

Output fields[3]

Field	Type
Message	text

Delete Ticket WatcherAction

Input fields[3]

Field	Type
Ticket IDRequired	choice

Output fields[3]

Field	Type
Message	text

Link a ContactAction

Input fields[3]

Field	Type
Visitor IDRequired	choice

Output fields[3]

Field	Type
Is agent	boolean
Message	text

Make An API Calluniversal

Input fields[3]

Field	Type
URLRequired	text
DomainRequired	text
MethodRequired	choice
Headers	array
Header	object
Query String	array
Parameter	object
Body	text

Output fields[3]

Field	Type
Body	text
Headers	object
Status code	number

Mark Ticket as SpamAction

Input fields[3]

Field	Type
Ticket IDRequired	choice
Block Contact	boolean

Output fields[3]

Field	Type
Message	text

Merge ContactAction

Input fields[3]

Field	Type
Primary Contact IDRequired	number
Secondary Contact IDsRequired	array

Output fields[3]

Field	Type
Contact external reference ID	text
Contact address	text
Contact custom fields	object
Cf contact custom name	text
Cf contact additional info	text
Cf contact custom checkbox	text
Cf contact custom yesno	text
Cf contact date	text
Cf contact datetime	text
Cf customer countries	text
Cf contact secondary email	text
Cf contact web link	text
Cf customer region	text
User ID	number
Contact name	text
Contact display name	text
Email ID	text
Is verified	boolean

13other output fields

Permanently Delete a VisitorAction

Input fields[3]

Field	Type
Visitor IDsRequired	choice

Output fields[3]

Field	Type
Message	text
Result	array

Permanently Delete ContactAction

Input fields[3]

Field	Type
Contact IDsRequired	choice
Force Delete	boolean

Output fields[3]

Field	Type
Contact ID	number
Is success	boolean

Reject an ApproverAction

Input fields[3]

Field	Type
Approval IDRequired	choice
Comment	text
Attachments	array
Attachment Token	text
Approval Reason ID	number

Output fields[3]

Field	Type
Message	text

Remove Tags From TicketAction

Input fields[3]

Field	Type
Ticket IDRequired	choice
TagsRequired	array
Tag	text

Output fields[3]

Field	Type
Message	text

Remove Ticket From SpamAction

Input fields[3]

Field	Type
Ticket IDRequired	choice
Unblock Contact	boolean

Output fields[3]

Field	Type
Message	text

Reply TicketAction

Input fields[3]

Field	Type
Ticket IDRequired	choice
Reply DescriptionRequired	text
Attachments	array
Attachment Token	text
Mentioned Users	array
User ID	number
Last Update ID	number
Last Refresh Date	date
Time Spent	number
Message Tags	array
Tag	text

12other input fields

Output fields[3]

Field	Type
ID	number
Is file upload success	boolean

Restore ConversationsAction

Input fields[3]

Field	Type
Conversation IDRequired	choice

Output fields[3]

Field	Type
Message	text

Restore TicketAction

Input fields[3]

Field	Type
Ticket IDRequired	choice

Send a MessageAction

Input fields[3]

Field	Type
Conversation IDRequired	choice
Private Message	boolean
User ID	choice
Visitor ID	choice
MessageRequired	text
Text FormatRequired	choice
Attachments	array
Attachment	object

Send an Approval ReminderAction

Input fields[3]

Field	Type
Approval IDRequired	choice
User IDsRequired	choice

Output fields[3]

Field	Type
Result	array
Message	text

Send Email TranscriptAction

Input fields[3]

Field	Type
Conversation IDRequired	choice
Send To Requester	boolean

Output fields[3]

Field	Type
Message	text

Unblock ContactAction

Input fields[3]

Field	Type
Contact IDRequired	choice
Remove Tickets from Spam	boolean

Output fields[3]

Field	Type
Message	text

Update a ContactAction

Input fields[3]

Field	Type
Contact IDRequired	choice
Skip Validation	boolean
Contact Name	text
Email ID	choice
Contact Display Name	text
Time Zone ID	choice
Language ID	choice
Contact Notes	text

9other input fields

Output fields[3]

Field	Type
Message	text

Update a ConversationAction

Input fields[3]

Field	Type
Conversation IDRequired	choice
Reason	text
Skip Dependency Validation	boolean
Assign Only If Null	boolean
Category ID	number
Status ID	number
Priority ID	number
Chat Agent ID	number

2other input fields

Output fields[3]

Field	Type
Message	text

Update a Ticket WorklogAction

Input fields[3]

Field	Type
Ticket IDRequired	choice
Description	text
Time Spent	number
Is BillableRequired	boolean
Worklog Date	date

Output fields[3]

Field	Type
Message	text

Update Agent Availability StatusAction

Input fields[3]

Field	Type
Agent User IDRequired	choice

Output fields[3]

Field	Type
Message	text

Update Agent FieldAction

Input fields[3]

Field	Type
Agent User IDRequired	choice
Skip Validation	boolean
Integration App ID	number
Modified User ID	number
Contact Name	text
Contact Display Name	text
Email	choice
Contact Tags	text

12other input fields

Update an AgentAction

Input fields[3]

Field	Type
Agent User IDRequired	choice
Agent Name	text
Email	choice
Display Name	text
Time Zone ID	choice
Has All Brand Access	boolean
Brand IDs	choice
Role IDs	choice

16other input fields

Output fields[3]

Field	Type
Message	text

Update an ActivityAction

Input fields[3]

Field	Type
Activity IDRequired	choice
Skip Dependency Validation	boolean
Activity SubjectRequired	text
Activity StatusRequired	number
Activity Priority	number
Activity Agent	number
Activity Description	text
Activity Linked Ticket	number

9other input fields

Output fields[3]

Field	Type
Message	text

Update Approval RequestAction

Input fields[3]

Field	Type
Approval IDRequired	choice
Subject	text
Description	text
Time Spent	number
Is Billable	boolean

Output fields[3]

Field	Type
Message	text

Update Contact NoteAction

Input fields[3]

Field	Type
Note IDRequired	number
Subject	text
DescriptionRequired	text
Attachments	text

Output fields[3]

Field	Type
Message	text

Update GroupAction

Input fields[3]

Field	Type
Group IDRequired	choice
Group NameRequired	text
Description	text
Business Hour ID	number

Output fields[3]

Field	Type
Message	text
Short code	text
Color code	text

Update Group Member Auto Assignment SettingsAction

Input fields[3]

Field	Type
Group IDRequired	choice
Participate In Ticket Auto Assignment	boolean
Participate In Chat Auto Assignment	boolean
Skip Assignee Changes	boolean
Group Owner	boolean
New Agent ID	number
New Group ID	number
Reassign Group Or Agent	boolean

2other input fields

Output fields[3]

Field	Type
Result	text

Update TicketAction

Input fields[3]

Field	Type
Ticket IDRequired	choice
Skip Validation	boolean
Category ID	number
Type ID	number
Status ID	number
Priority ID	number
Agent ID	choice
Group ID	choice

10other input fields

Output fields[3]

Field	Type
Is success	boolean
Message	text

Verify UserAction

Input fields[3]

Field	Type
User IDRequired	choice

Output fields[3]

Field	Type
Message	text

Templates

Look for BoldDesk templates in the WEXTL template library.

Browse templates →

Explore alternative apps

More apps in Support category →

References

WEXTL® BoldDesk Source Code connector implementation.
Our users use cases and automations.
Official API Documentation for BoldDesk.
WEXTL® visual workflow builder data.

Last updated: Jul 21, 2026 15:22

How we write our apps documentation

How we compile these docs — sources, AI's role, and how we verify.