Newer Version Available
AutoResponseRules
Represents an auto-response rule that sets conditions
for sending automatic email responses to lead or case submissions based on the
attributes of the submitted record. You can access rules metadata for all applicable
objects, for a specific object, or for a specific rule on a specific
object.
The package.xml syntax for accessing all auto-response rules for
all objects
is:
All
rules for a specific object uses a similar syntax without the wildcard. For example,
all auto-response rules for the Case object would use this
syntax:
You
can also access specific auto-response rules for an object. The following example
only accesses the “samplerule” and “newrule”
auto-response rules on the Case object. Notice that for this example the type name
syntax is AutoResponseRule and not AutoResponseRules.
File Suffix and Directory Location
AutoResponseRules for an object have the suffix .autoResponseRules and are stored in the autoResponseRules folder. For example, all Case auto-response rules are stored in the Case.autoResponseRules file.
Version
AutoResponseRules components are available in API version 27.0 and later.
Fields
| Field Name | Field Type | Description |
|---|---|---|
| autoresponseRule | AutoResponseRule[] | Represents the definitions of the named auto-response rules. |
AutoResponseRule
Represents whether a rule is active or not and the order in which the entry is processed in the rule.
| Field Name | Field Type | Description |
|---|---|---|
| active | boolean | Indicates whether the autoresponse rule is active (true) or not (false). |
| fullname | string | Inherited from Metadata,
this field is not defined in the WSDL for this metadata type. It
must be specified when creating, updating, or deleting. See
create() to see an example of this field specified for a
call. This value cannot be null. |
| ruleEntry | RuleEntry[] | Represents the type and description for the auto-response rule. |
RuleEntry
Represents the fields used by the rule.
| Field Name | Field Type | Description |
|---|---|---|
| booleanFilter | string | Advanced filter conditions that were specified for the rule. |
| criteriaItems | FilterItem[] | The items in the list that define the assignment criteria. |
| formula | string | The validation formula. |
| replyToEmail | string | The email address that appears in the reply-to header. |
| senderEmail | string | The email address of the person or queue sending the email notification. |
| senderName | string | The name of the person or queue sending the email notification. |
| template | string | Specifies the template to use for the email that is automatically sent to the designated recipient. |