AutoResponseRules Metadata Type Reference

The AutoResponseRules metadata type configures automatic acknowledgment emails sent to customers or prospects when a Case or Lead is created (via Web-to-Lead, Web-to-Case, Email-to-Case, Customer Portal, or API with EmailHeader.triggerAutoResponseEmail). Introduced in API version 27.0, an active AutoResponseRule evaluates <ruleEntry> blocks in top-to-bottom sequence and sends the EmailTemplate defined on the first matching entry.

In Salesforce DX projects, auto-response rules are stored in force-app/main/default/autoResponseRules/Case.autoResponseRules-meta.xml and Lead.autoResponseRules-meta.xml.

Key Fields on AutoResponseRule and RuleEntry#

Production-Grade XML Example (Case.autoResponseRules-meta.xml)#

<?xml version="1.0" encoding="UTF-8"?>
<AutoResponseRules xmlns="http://soap.sforce.com/2006/04/metadata">
    <autoResponseRule>
        <fullName>Customer_Support_Auto_Response</fullName>
        <active>true</active>
        <ruleEntry>
            <criteriaItems>
                <field>Case.Priority</field>
                <operation>equals</operation>
                <value>Critical,High</value>
            </criteriaItems>
            <notifyCcRecipients>true</notifyCcRecipients>
            <replyToEmail>support@example.com</replyToEmail>
            <senderEmail>noreply-support@example.com</senderEmail>
            <senderName>Enterprise Priority Support</senderName>
            <template>Support_Templates/Priority_Case_Acknowledgment</template>
        </ruleEntry>
        <ruleEntry>
            <formula>TRUE</formula>
            <notifyCcRecipients>false</notifyCcRecipients>
            <replyToEmail>support@example.com</replyToEmail>
            <senderEmail>noreply-support@example.com</senderEmail>
            <senderName>Customer Support Team</senderName>
            <template>Support_Templates/Standard_Case_Acknowledgment</template>
        </ruleEntry>
    </autoResponseRule>
</AutoResponseRules>

Triggering Auto-Response Emails in Apex#

Database.DMLOptions dmlOpts = new Database.DMLOptions();
dmlOpts.emailHeader.triggerAutoResponseEmail = true;

Lead webLead = new Lead(
    FirstName = 'Aarav',
    LastName = 'Mehta',
    Company = 'CloudScale India',
    Email = 'aarav@cloudscale.example.com'
);
webLead.setOptions(dmlOpts);
insert as user webLead;

Frequently asked questions

Which Salesforce objects support AutoResponseRules metadata?

Only Lead (Lead.autoResponseRules-meta.xml) and Case (Case.autoResponseRules-meta.xml) support AutoResponseRules.

How many AutoResponseRules can be active at the same time per object?

Only one AutoResponseRule per object (one for Lead and one for Case) can have active set to true at any given time, though that active rule can contain many ordered ruleEntry blocks.

Why did my AutoResponseRules deployment fail on the senderEmail field?

The email address specified in senderEmail on a ruleEntry must match a verified Organization-Wide Email Address in the target org, or the deployment will fail validation.

How many emails are sent if a Case matches three ruleEntry blocks inside an active AutoResponseRule?

Only one email is sent. Salesforce evaluates ruleEntry blocks top-to-bottom and stops as soon as the first matching ruleEntry fires.

How do I trigger AutoResponseRules when inserting a Lead or Case via Apex or SOAP/REST API?

Set Database.DMLOptions.EmailHeader.triggerAutoResponseEmail = true on the record or DML operation in Apex, or pass the EmailHeader SOAP/REST header.