| CARVIEW |
- White Papers
- A Guide to Multi-Channel Customer Support
- An Inside Look Into How Groupon Does Support
- Guide to Customizing and Integrating Your Zendesk
- How To Support Your Customers with Twitter
- Saas Help Desk Software: Your 6 Requirements
- Selecting Help Desk Software for the Enterprise
- Zendesk for Salesforce: An Integration Guide
- Webinars
- Why Zendesk?
- Batchbook + Zendesk Webinar Integration
- Capture the Definitive Business Metric: Customer Satisfaction
- Customer Support Made Easy: Why Zendesk?
- CSS in Zendesk
- Customizing Zendesk to Work for You
- Get Satisfaction + Zendesk Integration Webinar
- Getting Started with your Zendesk
- Getting Started: Intermediate
- GoodData for Zendesk Webinar
- JIRA + Zendesk Integration Webinar
- LiquidPlanner + Zendesk Integration Webinar
- LogMeIn Rescue for Zendesk – Remote Support Solution Webinar
- New Release of GoodData for Zendesk
- Salesforce + Zendesk Integration Webinar
- SurveyGizmo + Zendesk Integration Webinar
- Sweeten your help desk with an integration to SugarCRM
- Webinar: Tips and Tricks for Getting the Most Out of Zendesk
- Zendesk for iPad
- What’s New?
- Zendesk for Seesmic Desktop
- Zendesk for Twitter 2.0
- Zendesk New Community Features Webinar
- Zenfession: BigTent
- Zenfession: Postbox
- Ifbyphone for Zendesk Integration
- Customer Stories
- API
- Documentation
- Partners
- Newsletter
Mail API
Rest API
- Introduction
- Organizations
- Groups
- Tickets
- Attachments
- Users
- Tags
- Forums
- Entries
- Search
- Ticket Fields
- Macros
Widgets
Remote Authentication
Targets
Mail API: Usage
Help desk users can submit a new ticket by sending an email to support@accountname.zendesk.com, where accountname is the subdomain of your help desk.
When a ticket is updated the requester and assignee of the ticket receive updates per mail. This is called a notification. By replying to the notification, the ticket is commented accordingly.
Notifications are sent via triggers and are fully configurable. Adjust and create notifications that fits your business rules.
The Mail API
The mail API allows you to set properties on tickets by adding some specific commands to the mail subject. This is considered a high-level integration method.
IMPORTANT: In order to set properties via the mail API, the sender of the mail must be an agent.
Agents in your help desk can set properties when working with tickets via mail. Properties are set in the subject of the mail and are enclosed by double curly brackets. Thus, by including {{assignee:joe priority:high}} in the subject, you assign the ticket to “Joe”, and set the priority to high. If more than one agent named “Joe” exists in your help desk, the first one found will be used. You can use quotes to delimit full names, e.g. {{assignee:“Joe Doe”}}.
Ticket properties that can be set via mail – as long as the sender is a registered agent.
syntax
The email API retrieves the properties from the first set of double braces it encounters, and you must put all properties that you wish to set into the same set of braces. For example, this is valid:
{{requester:customer@example.com assignee:agent@example.com tags:”really important”}}
Whereas the following is *invalid* and we do not guarantee any usable results:
{{requester:customer@example.com}} {{assignee:agent@example.com}}
Please make sure to only have one set of {{ and }} in your subject for things to work as expected.
status
Valid values are open, pending and solved. Assignee must be set in order to set a ticket to Solved.
requester
Sets the requester of the ticket – only relevant when creating a ticket. The “from” email address is always set to the submitter. Valid values are the email address of the requester or the requester’s internal Zendesk ID (obtained via e.g. a REST integration). If you are setting the requester via email address, the requester will automatically be created in the help desk if the requester does not already exist.
group
Assigns the ticket to a group. Valid values are the name of the group or the ID of a group.
assignee
Assigns the ticket to an agent. Valid values are the email address of the assignee or the Zendesk ID of the assignee (obtained via e.g. a REST integration).
priority
Sets the priority of the ticket. Valid values are low, normal, high and urgent. Note, in order to set a priority, you must also set a ticket type (see below)
ticket_type
Valid values are incident, question, task and problem.
tags
Set any tag on the ticket, or multiple tags delimited by quotes, e.g. {{tags:something}} or {{tags:“another thing”}}
public
Sets if a comment update on a ticket is public. Defaults to true, and will only be set to false when set to {{public:false}}. Only useable when updating a ticket.
Notice that any invalid property settings will discard all property settings for the mail operation (e.g. designating an assignee without designating a group, when a help desk has more than one group).
A few examples: {{assignee:123}} – assigns the ticket to the agent with ID 123. {{assignee:john@johnsupport.com priority:high}} – assigns the ticket to the agent with email john@johnsupport.com and sets the ticket priority to high.