ActivationPlatform

Represents metadata about ActivationPlatform, such as platform name, delivery schedule, output format, and destination folder. This object is available in API version 54.0 and later.

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

Supported SOAP API Calls

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

Supported REST API Methods

DELETE, GET, HEAD, PATCH, POST, Query

Fields

Field	Details
Description	Type textarea Properties Nillable Description The description of the activation platform.
DeveloperName	Type string 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 Properties Defaulted on create, Filter, Group, Sort Description Indicates whether this Activation Platform is enabled (`true`) or not (`false`). The default value is `false`.
FullName	Type string Properties Create, Group, Nillable Description The full name of the associated ActivationPlatform in Metadata API. The full name can include a namespace prefix.
IncludeSegmentNames	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether to include the segment name in the metadata (`true`) or not (`false`). The default value is `false`.
Language	Type picklist 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.
LogoUrl	Type textarea Properties Nillable Description Logo for the activation channel destination.
ManageableState	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates the manageable state of the specified component that is contained in a package. Possible values are: `beta` `deleted` `deprecated` `deprecatedEditable` `installed` `installedEditable` `released` `unmanaged`
MasterLabel	Type string Properties Filter, Group, Sort Description Label for the ActivationPlatform. In the UI, this field is ActivationPlatform.
Metadata	Type ActivationPlatform Properties Create, Nillable, Update Description Provides access to the associated type.
NamespacePrefix	Type string Properties Filter, Group, Nillable, Sort Description The namespace of the ActivationPlatform.
Notes	Type textarea Properties Nillable Description Notes for this ActivationPlatform.
OutputFormat	Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The output format of the file. Possible values are: `CSV` `JSON` `PARQUET`
OutputGrouping	Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The grouping of the output. Possible values are: `PER_ACCOUNT` `PER_SEGMENT` `PER_USER`
PeriodicRefreshFrequency	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The full refresh frequency in days for incremental refresh mode. Available in API version 54.0 and later. Possible values are: `REFRESH_30` - Full refresh every 30 days `REFRESH_60` - Full refresh every 60 days This field applies only when outputGrouping is `PER_SEGMENT` and refreshMode is `INCREMENTAL`.
RefreshFrequency	Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Indicates how often the activation platform accepts data delivery in hours. Possible values are: `TWENTY_FOUR`
RefreshMode	Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The mode of refreshing the file. Possible values are: `INCREMENTAL`

Tooling API

ActivationPlatform

Supported SOAP API Calls

Supported REST API Methods

Fields