Helpdesk integration: operations for AI agents
Helpdesk connects to Type.com as an integration. This page lists the 139 operations documented for Claude and Codex in Type.com: 67 read, 43 write, 29 destructive.
About Helpdesk
HelpDesk.com vendor API references, subject to vendor permissions and account availability.
Categories: Customer Support
How to connect Helpdesk to Type.com
- Access
- Organization connection: one shared account for the workspace.
To add the connection, follow the steps in Space connections.
Documented operations
139 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
139 operations listed.
Agents
- Read
List agents
List agents
GET /v1/agents - Read
Get agent
Get agent
GET /v1/agents/{agentID} - Write
Create agent
Create agent
POST /v1/agents - Destructive
Batch update agents
Batch update agents
PATCH /v1/agents - Destructive
Update agent
Update agent
PATCH /v1/agents/{agentID} - Destructive
Delete agent
Delete agent
DELETE /v1/agents/{agentID}
Canned responses
- Read
List canned responses
List canned responses
GET /v1/cannedResponses - Read
Get canned response
Get canned response
GET /v1/cannedResponses/{cannedResponseID} - Write
Create canned response
Create canned response
POST /v1/cannedResponses - Write
Update canned response
Update canned response
PATCH /v1/cannedResponses/{cannedResponseID} - Destructive
Delete canned response
Delete canned response
DELETE /v1/cannedResponses/{cannedResponseID}
Custom fields
- Read
List custom fields
List custom fields
GET /v1/customFields - Read
Get custom field
Get custom field
GET /v1/customFields/{customFieldID} - Write
Create custom field
Create custom field
POST /v1/customFields - Write
Update custom field
Update custom field
PATCH /v1/customFields/{customFieldID} - Destructive
Delete custom field
Delete custom field
DELETE /v1/customFields/{customFieldID}
Email domains
- Read
Email domains list
Email domains list
GET /v1/emailDomains - Read
Get email domain
Get email domain
GET /v1/emailDomains/{emailDomainID} - Read
Check domain availability
Check domain availability
GET /v1/emailDomains/available - Write
Create email domain
Create email domain
POST /v1/emailDomains - Write
Verify email domain
Verify email domain
POST /v1/emailDomains/{emailDomainID}/verify - Destructive
Delete email domain
Delete email domain
DELETE /v1/emailDomains/{emailDomainID}
Forwarding emails
- Write
Test email forwarding
Sends a verification email to the supplied address. A successful result is delivered asynchronously through the agent websocket. The client is responsible for handling a missing response.
POST /v1/forwardingEmails
Mailboxes (inboxes)
- Read
List mailboxes
List mailboxes
GET /v1/mailboxes - Read
Get mailbox
Get mailbox
GET /v1/mailboxes/{mailboxID} - Write
Create mailbox
Create mailbox
POST /v1/mailboxes - Write
Update mailbox
Update mailbox
PATCH /v1/mailboxes/{mailboxID} - Destructive
Delete mailbox
Delete mailbox
DELETE /v1/mailboxes/{mailboxID}
Licenses
- Read
List licenses
Returns list of licenses. Normally it contains only one element.
GET /v1/licenses - Read
Get license
Returns license data by `licenseID`.
GET /v1/licenses/{licenseID} - Write
Create license
Creates new license object. Only required during first app login after account in HelpDesk Accounts has been created.
POST /v1/licenses - Write
Update license
Allows changing license settings: - default team - default template - company name
PATCH /v1/licenses/{licenseID} - Write
Send forwarding instructions
Sends email with instructions on setting up email forwarding.
PUT /v1/licenses/{licenseID}/forwardingInstructions
Reply addresses
- Read
List reply addresses
List reply addresses
GET /v1/replyAddresses - Read
Get reply address
Get reply address
GET /v1/replyAddresses/{replyAddressID} - Write
Create reply address
Create reply address
POST /v1/replyAddresses - Destructive
Delete reply address
Delete reply address
DELETE /v1/replyAddresses/{replyAddressID}
Reports
- Read
New tickets
New tickets
GET /v1/reports/newTickets - Read
Ticket sources
Ticket sources
GET /v1/reports/ticketSources - Read
Ticket rating
Ticket rating
GET /v1/reports/rating - Read
Agent rating
Agent rating
GET /v1/reports/agentRating - Read
Rating per agent
Rating per agent
GET /v1/reports/ratingPerAgent - Read
Rating per team
Rating per team
GET /v1/reports/ratingPerTeam - Read
Ticket status
Ticket status
GET /v1/reports/status - Read
Tickets status per agent
Tickets status per agent
GET /v1/reports/statusPerAgent - Read
Tickets status per team
Tickets status per team
GET /v1/reports/statusPerTeam - Read
Response time
Response time
GET /v1/reports/responseTime - Read
Response time per agent
Response time per agent
GET /v1/reports/responseTimePerAgent - Read
Response time per team
Response time per team
GET /v1/reports/responseTimePerTeam - Read
Resolution time
Resolution time
GET /v1/reports/resolutionTime - Read
Resolution time per agent
Resolution time per agent
GET /v1/reports/resolutionTimePerAgent - Read
Resolution time per team
Resolution time per team
GET /v1/reports/resolutionTimePerTeam - Read
New tickets (24h distribution)
New tickets (24h distribution)
GET /v1/reports/newTickets24 - Read
Ticket sources (24h distribution)
Ticket sources (24h distribution)
GET /v1/reports/ticketSources24 - Read
Ticket rating (24h distribution)
Ticket rating (24h distribution)
GET /v1/reports/rating24 - Read
Ticket status (24h distribution)
Ticket status (24h distribution)
GET /v1/reports/status24 - Read
Response time (24h distribution)
Response time (24h distribution)
GET /v1/reports/responseTime24 - Read
Resolution time (24h distribution)
Resolution time (24h distribution)
GET /v1/reports/resolutionTime24 - Read
Failed outgoing emails
Failed outgoing emails
GET /v1/reports/failedEmails - Read
Tickets status duration
Tickets status duration
GET /v1/reports/statusDuration - Read
Tickets status duration total
Tickets status duration total
GET /v1/reports/statusDurationTotal - Read
Tickets status duration per agent
Tickets status duration per agent
GET /v1/reports/statusDurationPerAgent - Read
Tickets status duration per team
Tickets status duration per team
GET /v1/reports/statusDurationPerTeam - Write
Create custom report
Create custom report
POST /v1/reports
Rules
- Read
List rules
List rules
GET /v1/rules - Read
Get rule
Get rule
GET /v1/rules/{ruleID} - Write
Create rule
Create rule
POST /v1/rules - Write
Update rule
Update rule
PATCH /v1/rules/{ruleID} - Destructive
Delete rule
Delete rule
DELETE /v1/rules/{ruleID}
Macros
- Read
Macros list
Macros list
GET /v1/macros - Read
Get macro
Get macro
GET /v1/macros/{macroID} - Write
Create macro
Create macro
POST /v1/macros - Write
Update macro
Update macro
PATCH /v1/macros/{macroID} - Destructive
Delete macro
Delete macro
DELETE /v1/macros/{macroID}
Spam management
- Read
List trusted emails
List trusted emails
GET /v1/trustedEmails - Read
Get trusted email
Get trusted email
GET /v1/trustedEmails/{trustedEmailID} - Read
List blocked emails
List blocked emails
GET /v1/blockedEmails - Read
Get blocked email
Get blocked email
GET /v1/blockedEmails/{blockedEmailID} - Write
Trust an email
Trust an email
POST /v1/trustedEmails - Destructive
Remove trusted email
Remove trusted email
DELETE /v1/trustedEmails/{trustedEmailID} - Destructive
Block an email
Block an email
POST /v1/blockedEmails - Destructive
Remove blocked email
Remove blocked email
DELETE /v1/blockedEmails/{blockedEmailID}
Subscriptions
- Read
List subscriptions
List subscriptions
GET /v1/subscriptions - Write
Create subscriptions
Create subscriptions
POST /v1/subscriptions - Write
Update subscription
Update subscription
PATCH /v1/subscriptions/{subscriptionID} - Destructive
Cancel subscription
Cancel subscription
PATCH /v1/subscriptions/{subscriptionID}/cancel - Destructive
Terminate subscription
Terminate subscription
PATCH /v1/subscriptions/{subscriptionID}/terminate
Unsubscriptions
- Read
List unsubscriptions
Lists email addresses that requesters unsubscribed from receiving ticket notifications for on the current license. Requires the requesting agent to have admin privileges; otherwise the endpoint responds with `403 Forbidden`. Results are paginated with a keyset (cursor) on the unsubscription `ID`. To fetch the next page, pass the `ID` of the last item from the current page as `next.ID`.
GET /v1/unsubscriptions
Tags
- Read
List tags
List tags
GET /v1/tags - Read
Get tag
Get tag
GET /v1/tags/{tagID} - Write
Create tag
Create tag
POST /v1/tags - Write
Update tag
Update tag
PATCH /v1/tags/{tagID} - Destructive
Delete tag
Delete tag
DELETE /v1/tags/{tagID}
Teams
- Read
List teams
List teams
GET /v1/teams - Read
Get team
Get team
GET /v1/teams/{teamID} - Write
Create team
Create team
POST /v1/teams - Write
Update teams
Update teams
PATCH /v1/teams - Write
Update team
Update team
PATCH /v1/teams/{teamID} - Destructive
Delete team
Delete team
DELETE /v1/teams/{teamID}
Templates
- Read
List templates
List templates
GET /v1/templates - Read
Get template
Get template
GET /v1/templates/{templateID} - Read
Generate template preview
Generate template preview
POST /v1/templates/preview - Write
Create template
Create template
POST /v1/templates - Write
Update template
Update template
PATCH /v1/templates/{templateID} - Write
Send test message
Send test message
POST /v1/templates/sendTestMessage - Destructive
Delete template
Delete template
DELETE /v1/templates/{templateID}
Audit log
- Read
Returns audit log events
Returns audit log events
GET /v1/auditLog
Tickets
- Read
List tickets
List tickets
GET /v1/tickets - Read
Get ticket
Get ticket
GET /v1/tickets/{ticketID} - Read
Get original message content
Get original message content
GET /v1/tickets/{ticketID}/events/{eventID}/originalContent - Write
Create ticket
Create ticket
POST /v1/tickets - Write
Update ticket
Update ticket
PATCH /v1/tickets/{ticketID} - Write
Add tag
Add tag
POST /v1/tickets/{ticketID}/tags - Write
Add followers
Add followers
POST /v1/tickets/{ticketID}/followers - Write
Send rating request
Send rating request
POST /v1/tickets/{ticketID}/ratingRequests - Destructive
Delete ticket
Delete ticket
DELETE /v1/tickets/{ticketID} - Destructive
Remove tag
Remove tag
DELETE /v1/tickets/{ticketID}/tags/{tagID} - Destructive
Remove follower
Remove follower
DELETE /v1/tickets/{ticketID}/followers/{followerID} - Destructive
Merge ticket
Merge ticket
POST /v1/tickets/{ticketID}/childTickets - Destructive
Unmerge ticket
Unmerge ticket
DELETE /v1/tickets/{ticketID}/childTickets/{childTicketID} - Destructive
Move ticket to silo
Move ticket to silo
PUT /v1/tickets/{ticketID}/silo - Destructive
Delete tickets attachment
Delete tickets attachment
DELETE /v1/tickets/{ticketID}/events/{eventID}/attachments/{attachmentID}
Transactions
- Read
Get transaction
Get transaction
GET /v1/transactions/{transactionID} - Write
Create transaction
Create transaction
POST /v1/transactions - Write
Upload attachment
Upload attachment
POST /v1/transactions/{transactionID}/attachments - Destructive
Delete attachment
Delete attachment
DELETE /v1/transactions/{transactionID}/attachments/{attachmentID}
Views
- Read
Views list
Views list
GET /v1/views - Read
Get view
Get view
GET /v1/views/{viewID} - Write
Create view
Create view
POST /v1/views - Write
Update view
Update view
PATCH /v1/views/{viewID} - Destructive
Delete view
Delete view
DELETE /v1/views/{viewID}
Webhooks
- Read
Webhooks list
Webhooks list
GET /v1/webhooks - Read
Get webhook
Get webhook
GET /v1/webhooks/{webhookID} - Write
Create webhook
Create webhook
POST /v1/webhooks - Destructive
Update webhook
Update webhook
PATCH /v1/webhooks/{webhookID} - Destructive
Delete webhook
Delete webhook
DELETE /v1/webhooks/{webhookID}
Imported tickets
- Write
Create imported ticket
By default this endpoint creates a **ticket without attachments**. If you want to create a ticket containing attachments: 1. Create new import transaction by issuing `POST` request to `/v1/importedTickets/transactions` endpoint 2. Upload attachments by issuing `POST` request(s) to `/v1/importedTickets/attachments` with proper `transactionID` acquired in step 1. The response will contain array with `attachmentIDs` you can use in step 3. 3. Create new ticket issuing `POST` request to `/v1/importedTickets` endpoint with additional `transactionID` parameter acquired in step 1 Remarks: - First event has to be of type `message` - Date of first message event is considered ticket creating date - Events have to be chronologically ordered and in the past - Events of type `message` and `attachments` are grouped together when the date parameter in both events match `attachment.files` array contains IDs generated during attachment upload - All uploaded attachments have to be used during ticket import - `TransactionID` stays valid for 24 hours - Ticket status can be changed using status event (last such status is used as final status) - Agent-issued message or attachment requires `agentID`, `agentName` and `isPrivate` parameters. Messages without these parameters are considered as requester-issued. These rules concern both message and attachments events.
POST /v1/importedTickets - Write
Create imported ticket transaction
Creates new import transaction. Transaction ID is required for ticket creation with attachments.
POST /v1/importedTickets/transactions - Write
Upload attachments for imported ticket
Uploads attachments for imported ticket. Attachments are required for ticket creation with attachments. Use multipart with `attachments` as key. Multiple files are allowed.
POST /v1/importedTickets/attachments
No operations match.
See How connections work for access and permissions, or browse all integrations.