---
schema_version: "1"
id: de32baef98f2ae75f408c6b385b59750c907bef28f57bed21d46bb8b60d779f0
title: ActivationPlatformField
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_activationplatformfield.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_activationplatformfield.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 6c9f80ea4ec12252bfa4035a2ab7e62b5a6a0a3c11c9c40bb3d2f8ae23265da5
description: Represents the information about the fields used in ActivationPlatform.
---
# ActivationPlatformField

Represents the information about the fields used in ActivationPlatform.

![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.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

ActivationPlatformField components have the suffix .activationPlatformField and are stored in the activationPlatformFields folder.

## Version

ActivationPlatformField components are available in API version 54.0 and later.

## Special Access Rules

There are no additional access requirements that are specific to this type.

## Fields

| Field Name | Description |
| --- | --- |
| activationPlatform | 
Field Type

string

Description

Required.

Reference to the ActivationPlatform metadata type.



 |
| helpText | 

Field Type

string

Description

Information about ActivationPlatformField.



 |
| isHidden | 

Field Type

boolean

Description

Required.

Indicates whether ActivationPlatformField can be overridden by marketer (false) or not (true). The default is false. Field can’t be overridden by marketer when set to true.



 |
| isRequired | 

Field Type

boolean

Description

Required.

Indicates whether this ActivationPlatformField is required (true) or not (false). The default is false.



 |
| masterLabel | 

Field Type

string

Description

Required.

The name of the ActivationPlaformField.



 |
| type | 

Field Type

ActivationPlatformFieldDataType (enumeration of type string)

Description

Represents the datatype of the field.

Valid value is:

- Text





 |

## Declarative Metadata Sample Definition

The following is an example of an ActivationPlatformField component.

<?xml version="1.0" encoding="UTF-8"?>
<ActivationPlatformField xmlns="http://soap.sforce.com/2006/04/metadata">
    <activationPlatform\>APlatform</activationPlatform\>
    <isHidden\>false</isHidden\>
    <isRequired\>true</isRequired\>
    <masterLabel\>AccountId</masterLabel\>
</ActivationPlatformField\>

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">
    <fullName\>MyActivationPlatform</fullName\>
    <types\>
        <members\>APlatform</members\>
        <name\>ActivationPlatform</name\>
    </types\>
    <types\>
        <members\>AccountIdField</members\>
        <name\>ActivationPlatformField</name\>
    </types\>
    <version\>54.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.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").