GenAiPromptTemplateActv

Represents the activation status of a Salesforce-provided prompt template.

This type extends Metadata and inherits its fields.

GenAiPromptTemplateActv components have the suffix .genAiPromptTemplateActivation and are stored in the genAiPromptTemplateActivations folder.

Introduced in API version 60.0.

GenAiPromptTemplate is available only if Prompt Builder is enabled in your org and you have the Prompt Template Manager permission.

• Type: GenAiPromptTemplateActvAccessLevel (enumeration of type string)
• Required: Yes
• Description: Indicates which users can access the Salesforce-provided prompt template.
• Possible values:
  • Allowed — Users with access to Prompt Builder can see the prompt template.
  • Blocked — Only admin users with access to Prompt Builder can see the prompt template.

• Type: string
• Required: Yes
• Description: Name of the activation record. This name can contain only underscores and alphanumeric characters. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.

• Type: string
• Required: No
• Description: A user-friendly name for GenAiPromptTemplateActv, which is defined when the GenAiPromptTemplateActv is created.

• Type: string
• Required: Yes
• Description: Name of the Salesforce-provided prompt template that the activation record is associated with.

The following is an example of a GenAiPromptTemplateActv component.

1<?xml version="1.0" encoding="UTF-8"?>
2<GenAiPromptTemplateActv xmlns="http://soap.sforce.com/2006/04/metadata">
3    <MasterLabel> Activation Record for Prompt Template </MasterLabel>
4    <PromptTemplateDeveloperName>einstein_gpt__introductionLeadEmail
5    </PromptTemplateDeveloperName>
6    <DeveloperName>HideIntroductionLeadEmail</DeveloperName>
7    <Description>Status of template </Description>
8    <AccessLevel>BLOCKED</AccessLevel>
9</GenAiPromptTemplateActv>

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <name>GenAiPromptTemplateActv</name>
5        <members>HideIntroductionLeadEmail.genAiPromptTemplateActivation</members>
6    </types>
7    <version>60.0</version>
8</Package>

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.