ActivationPlatform

Represents metadata about ActivationPlatform, such as platform name, delivery schedule, output format, and destination folder.

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.

Important

Version 

Introduced in API version 54.0.

Supported SOAP API Calls 

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Supported REST API Methods 

DELETE, GET, HEAD, PATCH, POST, Query

Fields 

ActivationFlowType 

• Type: picklist

• Required: No

• Properties: Filter, Group, Nillable, Restricted picklist, Sort

• Introduced: API version 61.0

• Possible values:

  • SEGMENT — Segment

  • DMO — Data Model Object

  • API_TRIGGERED — Api Triggered

  • TEMPLATE — Template

ActivationPlatformAdditionalMetadata 

• Type: textarea
• Required: No
• Properties: Nillable
• Introduced: API version 56.0

ActivationPlatformConnectorType 

• Type: picklist

• Required: No

• Properties: Filter, Group, Nillable, Restricted picklist, Sort

• Introduced: API version 56.0

• Possible values:

  • S3 — S3

  • OAUTH — OAUTH

ActivationPlatformCreationType 

• Type: picklist

• Required: No

• Properties: Filter, Group, Nillable, Restricted picklist, Sort

• Introduced: API version 63.0

• Possible values:

  • JSON — JSON

  • MANUAL — MANUAL

CustomerIdTypeMapping 

• Type: textarea
• Required: No
• Properties: Nillable
• Introduced: API version 63.0

DataConnectorId 

• Type: reference

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 54.0

• Relationship name: DataConnector

• Relationship type: polymorphic

• Refers to: ActvPfrmDataConnectorS3, ActvPlatformOAuthConnector

Description 

• Type: textarea

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 54.0

• Description: The description of the activation platform.

DeveloperName 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Description: The unique name for the ActivationPlatform object.

The unique name of the object in the API. 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. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization. Label is Record Type Name. This field is automatically generated, but you can supply your own value if you create the record using the API.

Enabled 

• Type: boolean

• Required: No

• Properties: Defaulted on create, Filter, Group, Sort

• Description: Indicates whether this Activation Platform is enabled (true) or not (false).

The default value is false.

• Default value: false

FullName 

• Type: string

• Required: No

• Properties: Create, Group, Nillable

• Introduced: API version 54.0

• Description: The full name of the associated ActivationPlatform in Metadata API. The full name can include a namespace prefix.

IncludeSegmentNames 

• Type: boolean

• Required: No

• Properties: Defaulted on create, Filter, Group, Sort

• Introduced: API version 54.0

• Description: Indicates whether to include the segment name in the metadata (true) or not (false).

The default value is false.

• Default value: false

Language 

• Type: picklist

• Required: No

• Properties: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort

• Description: The language of the ActivationPlatform. The value for this field is the language value of the org.

• Possible values:

  • en_US — English

  • de — German

  • es — Spanish

  • fr — French

  • it — Italian

  • ja — Japanese

  • sv — Swedish

  • ko — Korean

  • zh_TW — Chinese (Traditional)

  • zh_CN — Chinese (Simplified)

  • pt_BR — Portuguese (Brazil)

  • nl_NL — Dutch

  • da — Danish

  • th — Thai

  • fi — Finnish

  • ru — Russian

  • es_MX — Spanish (Mexico)

  • no — Norwegian

LogoUrl 

• Type: textarea

• Required: No

• Properties: Nillable

• Description: Logo for the activation channel destination.

ManageableState 

• Type: picklist

• Required: No

• Properties: Filter, Group, Nillable, Restricted picklist, Sort

• Description: Indicates the manageable state of the specified component that is contained in a package.

• Possible values:

  • beta — beta

  • deleted — deleted

  • deprecated — deprecated

  • deprecatedEditable — deprecatedEditable

  • installed — installed

  • installedEditable — installedEditable

  • released — released

  • unmanaged — unmanaged

MasterLabel 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Description: Label for the ActivationPlatform. In the UI, this field is ActivationPlatform.

Metadata 

• Type: complexvalue

• Required: No

• Properties: Create, Nillable, Update

• Introduced: API version 54.0

• Description: Provides access to the associated type.

NamespacePrefix 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The namespace of the ActivationPlatform.

Notes 

• Type: textarea

• Required: No

• Properties: Nillable

• Introduced: API version 54.0

• Description: Notes for this ActivationPlatform.

OutputFormat 

• Type: picklist

• Required: No

• Properties: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort

• Introduced: API version 54.0

• Description: The output format of the file.

• Possible values:

  • CSV — CSV

  • JSON — JSON

  • PARQUET — Parquet

OutputGrouping 

• Type: picklist

• Required: No

• Properties: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort

• Introduced: API version 54.0

• Description: The grouping of the output.

• Possible values:

  • PER_SEGMENT — PER_SEGMENT

  • PER_ACCOUNT — Files are grouped by account ID in an account-specific folder path.

  • PER_USER — PER_USER

PeriodicRefreshFrequecy 

• Type: picklist

• Required: No

• Properties: Filter, Group, Nillable, Restricted picklist, Sort

• Introduced: API version 54.0

• Possible values:

  • REFRESH_30 — Every 30 days

  • REFRESH_60 — Every 60 days

RefreshFrequency 

• Type: picklist

• Required: No

• Properties: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort

• Introduced: API version 54.0

• Description: Indicates how often the activation platform accepts data delivery in hours.

• Possible values:

  • FOUR — Every 4 hours

  • TWELVE — Every 12 hours

  • TWENTY_FOUR — Every 24 hours

RefreshMode 

• Type: picklist

• Required: No

• Properties: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort

• Introduced: API version 54.0

• Description: The mode of refreshing the file.

• Possible values:

  • FULL — Full Refresh

  • INCREMENTAL — Incremental Refresh