---
schema_version: "1"
id: dd23493bfa7cb6cb5b486240224c73257a54d0997db7f05920e570bb729f9730
title: GenAiPromptTemplateActv
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_genaiprompttemplateactv.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_genaiprompttemplateactv.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 573f159313a33c37ff8c8883ccbf970e2df20be543d0f4eab864b08128a4048e
description: Represents the activation status of a Salesforce-provided prompt template.
---
# GenAiPromptTemplateActv

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

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field.

## File Suffix and Directory Location

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

## Version

GenAiPromptTemplateActv components are available in API version 60.0 and later.

## Special Access Rules

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

## Fields

| Field Name | Description |
| --- | --- |
| accessLevel | 
Field Type

GenAiPromptTemplateActvAccessLevel ([enumeration](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_objects_intro.htm) of type string)

Description

Indicates which users can access the Salesforce-provided prompt template. Valid values are:

- 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.





 |
| developerName | 

Field Type

string

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.



 |
| masterLabel | 

Field Type

string

Description

A user-friendly name for GenAiPromptTemplateActv, which is defined when the GenAiPromptTemplateActv is created.



 |
| templateDeveloperName | 

Field Type

string

Description

Name of the Salesforce-provided prompt template that the activation record is associated with.



 |

## Declarative Metadata Sample Definition

The following is an example of a GenAiPromptTemplateActv component.

<?xml version="1.0" encoding="UTF-8"?>
<GenAiPromptTemplateActv xmlns="http://soap.sforce.com/2006/04/metadata">
    <MasterLabel\> Activation Record for Prompt Template </MasterLabel\>
    <PromptTemplateDeveloperName\>einstein\_gpt\_\_introductionLeadEmail
    </PromptTemplateDeveloperName\>
    <DeveloperName\>HideIntroductionLeadEmail</DeveloperName\>
    <Description\>Status of template </Description\>
    <AccessLevel\>BLOCKED</AccessLevel\>
</GenAiPromptTemplateActv\>

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

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

## Wildcard Support in the Manifest File

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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).