---
schema_version: "1"
id: 79c19cf6e2987f471bece926adfdcd2deaf3464ab8362d810c02bf8a263c95c6
title: MarketingAppExtension
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_marketingappextension.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_marketingappextension.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 392b3bfe13108ea2fdceb46bfd0e8a5b853564d1746f2985d36c825bb34d8149
description: Represents an integration with a third-party app or service that is used to work with prospects.
---
# MarketingAppExtension

Represents an integration with a third-party app or service that is used to work with prospects.

![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.") type and inherits its fullName field.

## File Suffix and Directory Location

MarketingAppExtension components have the suffix .marketingappextension and are stored in the marketingappextensions folder.

## Version

MarketingAppExtension components are available in API version 54.0 and later.

## Special Access Rules

The first Salesforce or designated marketing admin to access Marketing App Extensions in an org must have the Manage Public List Views user permission. Subsequent users don’t need the permission to work with the feature.

## Fields

| Field Name | Description |
| --- | --- |
| description | 
Field Type

string

Description

The description of the extension for internal reference. Appears in the UI.



 |
| isActive | 

Field Type

boolean

Description

This field makes data for a Marketing App Extension available to use in Account Engagement automations. Label is Active in Automations.

The default value is false. Appears in the UI.



 |
| isProtected | 

Field Type

boolean



 |
| marketingAppExtActions | 

Field Type

[MarketingAppExtAction](#subtype_MarketingAppExtAction)\[\]

Description

This field is a related list of associated external actions.



 |
| marketingAppExtActivities | 

Field Type

[MarketingAppExtActivity](#subtype_MarketingAppExtActivity)\[\]

Description

This field is a related list of associated external prospect activities.



 |
| masterLabel | 

Field Type

string

Description

Required. Label for the MarketingAppExtension. In the UI, this field is Extension Name.





 |

## MarketingAppExtActivity

Represents an Activity Type, which is a prospect activity that occurs in a third-party app and can be used in Account Engagement automations.

| Field Name | Description |
| --- | --- |
| description | 
Field Type

string

Description

The description of the activity for internal reference. Appears in the UI.



 |
| endpointUrl | 

Field Type

string

Description

A sample endpoint that can be used to help connect the activity type to a third-party app. Appears in the UI.



 |
| isActive | 

Field Type

boolean

Description

This field makes data for the Activity Type available to use in Account Engagement automations. Label is Active in Automations.

The default value is false. Appears in the UI.



 |
| isProtected | 

Field Type

boolean



 |
| marketingAppExtension | 

Field Type

string

Description

Required. The Marketing App Extension associated with the activity.



 |
| masterLabel | 

Type

string

Description

Required. Label for the MarketingAppExtActivity. In the UI, this field is Activity Name.



 |

## Declarative Metadata Sample Definition

This example retrieves all Activity Types associated with the MarketingAppExtension component.

<?xml version="1.0" encoding="UTF-8"?>
<MarketingAppExtension xmlns="http://soap.sforce.com/2006/04/metadata">
    <description\>VidLand extension for US region</description\>
    <isActive\>true</isActive\>
    <marketingAppExtActivities\>
        <fullName\>user\_attended</fullName\>
        <description\>User attended activity capture for VidLand</description\>
        <isActive\>true</isActive\>
        <marketingAppExtension\>VidLand\_US</marketingAppExtension\>
        <masterLabel\>user attended</masterLabel\>
    </marketingAppExtActivities\>
    <marketingAppExtActivities\>
        <fullName\>user\_registered</fullName\>
        <description\>User registered activity capture for VidLand</description\>
        <isActive\>true</isActive\>
        <marketingAppExtension\>VidLand\_US</marketingAppExtension\>
        <masterLabel\>user registered</masterLabel\>
    </marketingAppExtActivities\>
    <masterLabel\>VidLand\_US</masterLabel\>
</MarketingAppExtension\>

This example package.xml references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<!--
~ Copyright 2021 Salesforce, Inc.
~ All Rights Reserved
~ Company Confidential
-->
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types\>
<members\>VidLand\_US</members\>
<name\>MarketingAppExtension</name\>
</types\>
</Package\>

This example retrieves a specific Activity Type from the associated MarketingAppExtension component.

<?xml version="1.0" encoding="UTF-8"?>
<MarketingAppExtension xmlns="http://soap.sforce.com/2006/04/metadata">
    <description\>VidLand extension for US region</description\>
    <isActive\>true</isActive\>
    <marketingAppExtActivities\>
        <fullName\>user\_attended</fullName\>
        <description\>User attended activity capture for VidLand</description\>
        <isActive\>true</isActive\>
        <marketingAppExtension\>VidLand\_US</marketingAppExtension\>
        <masterLabel\>user attended</masterLabel\>
    </marketingAppExtActivities\>
    <masterLabel\>VidLand\_US</masterLabel\>
</MarketingAppExtension\>

This example package.xml references the previous definition.

<<?xml version="1.0" encoding="UTF-8"?>
<!--
~ Copyright 2021 salesforce.com, inc.
~ All Rights Reserved
~ Company Confidential
-->
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types\>
<members\>VidLand\_US.user\_attended</members\>
<name\>MarketingAppExtActivity</name\>
</types\>
<types\>
<members\>VidLand\_US</members\>
<name\>MarketingAppExtension</name\>
</types\>
</Package\>

## MarketingAppExtAction

Represents an Action Type, which is an action that executes in a third-party app and can be used in Engagement Studio programs.

| Field Name | Description |
| --- | --- |
| actionName | 
Field Type

string

Description

The name of the action for internal use. Appears in the UI.



 |
| actionParams | 

Field Type

string

Description

The parameters for the invocable action. Appears in the UI.



 |
| actionSchema | 

Field Type

string

Description

The JSON schema for the invocable action. Appears in the UI.



 |
| actionSelector | 

Type

string

Description

Invocable action selector. Appears in the UI.



 |
| apiName | 

Field Type

string

Description

This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. This field is automatically generated, but you can supply your own value if you create the record using the API. Appears in the UI.



 |
| Description | 

Field Type

string

Description

The description of the action for internal reference. Appears in the UI.



 |
| isActive | 

Field Type

boolean

Description

This field makes data for the Action Type available to use in Engagement Studio Label is Active in Automations.

The default value is false. Appears in the UI.



 |
| marketingAppExtension | 

Field Type

string

Description

Required. The Marketing App Extension associated with the action.



 |

## Declarative Metadata Sample Definition

This example retrieves a specific action associated the MarketingAppExtension component.

<?xml version="1.0" encoding="UTF-8"?>
<MarketingAppExtension xmlns="http://soap.sforce.com/2006/04/metadata">
    <fullName\>VidLand\_US</fullName\>
    <description\>VidLand extension for US region</description\>
    <isActive\>true</isActive\>
    <marketingAppExtActions\>
        <marketingAppExtension\>VidLand\_US</marketingAppExtension\>
        <apiName\>register\_user</apiName\>
        <isActive\>true</isActive\>
        <description\>Register User for VidLand</description\>>
        <actionSelector\>VidLand\_Register\_User</actionSelector\>
        <actionSchema\>
			<!\[CDATA\[
   				{
	"properties": {
	  "UserId": {
		"type": "string",
		"title": ""
	  },
	  "WebinarId": {
		"type": "string",
		"value": "webinarIdXYZ"
	  }
	},
	"view": {
	  "components": \[{
		"definition": "lightning/control",
		"scope": "#/properties/UserId"
	  }\]
	},
	"required": \[
	  "UserId",
	  "WebinarId",
	  "From",
	  "Body"
	\]
  }
			\]\]>
        </actionSchema\>
        <actionParams\>
        <!\[CDATA\[
   				{
	"isStandard": false,
    "type": "apex"
  }
			\]\]>
        </actionParams\>
        <actionName\>Register User</actionName\>
    </marketingAppExtActions\>
    <masterLabel\>VidLand US</masterLabel\>
</MarketingAppExtension\>

This example package.xml references the previous definition.

<<?xml version="1.0" encoding="UTF-8"?>
<!--
~ Copyright 2021 salesforce.com, inc.
~ All Rights Reserved
~ Company Confidential
-->
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types\>
<members\>VidLand\_US</members\>
<name\>MarketingAppExtension</name\>
</types\>
</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.").