Translations

Metadata type that enables work with translations for various supported languages. The ability to translate component labels is part of the Translation Workbench.

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.

This type extends Metadata and inherits its fields.

A two-character language code identifies each language. For example, en. A five-character code is used for languages that differ depending on location. For example, en_AU.

Setting a default language is different from setting a default locale. For more information, see Select Your Language, Locale, and Currency in Salesforce Help.

Salesforce offers full support for these languages.

  • Chinese (Simplified): zh_CN
  • Chinese (Traditional): zh_TW
  • Danish: da
  • Dutch: nl_NL
  • English: en_US
  • Finnish: fi
  • French: fr
  • German: de
  • Italian: it
  • Japanese: ja
  • Korean: ko
  • Norwegian: no
  • Portuguese (Brazil): pt_BR
  • Russian: ru
  • Spanish: es
  • Spanish (Mexico): es_MX Defaults to Spanish for customer-defined translations.
  • Swedish: sv
  • Thai: th The Salesforce user interface is fully translated to Thai, but Salesforce Help is in English.

End-user languages are useful if you have a multilingual organization or partners who speak languages other than your company’s default language. For end-user languages, Salesforce provides translated labels for standard objects and pages, except admin pages, Setup, and Help. Some clouds and features support a subset of these languages in the UI. For details, see User Interface Language Support in Salesforce Help. When you select an end-user language, labels that aren’t translated and Salesforce Help are in English. End-user languages are intended only for personal use by end users. Don’t use end-user languages as corporate languages. Salesforce doesn’t provide customer support in end-user languages.

End-user languages include:

  • Arabic: ar
  • Bulgarian: bg
  • Croatian: hr
  • Czech: cs
  • English (UK): en_GB
  • Greek: el
  • Hebrew: iw
  • Hungarian: hu
  • Indonesian: in
  • Polish: pl
  • Portuguese (European): pt_PT
  • Romanian: ro
  • Slovak: sk
  • Slovenian: sl
  • Turkish: tr
  • Ukrainian: uk
  • Vietnamese: vi

Before enabling end-user languages Arabic and Hebrew, review the right-to-left language support limitations.

In situations where Salesforce doesn’t provide default translations, use platform-only languages to localize apps and custom functionality that you build on the Salesforce Platform. You can translate items such as custom labels, custom objects, and field names. You can also rename most standard objects, labels, and fields. Informational text and non-field label text aren’t translatable.

Platform-only languages are available in all places where you can select a language in the application. However, when you select a platform-only language, all standard Salesforce labels default to English or, in select cases, to an end-user or fully supported language.

Language support is closely tied to the API version. For example, we introduced support for Belgian Dutch (nl_BE) in API version 40.0. To take advantage of this language, you must use API version 40.0 or later. In general, we recommend the most recent version of the API to make the most of our language features.

Platform-only languages include:

  • Albanian: sq
  • Afrikaans: af
  • Amharic: am
  • Arabic (Algeria): ar_DZ
  • Arabic (Bahrain): ar_BH
  • Arabic (Egypt): ar_EG
  • Arabic (Iraq): ar_IQ
  • Arabic (Jordan): ar_JO
  • Arabic (Kuwait): ar_KW
  • Arabic (Lebanon): ar_LB
  • Arabic (Libya): ar_LY
  • Arabic (Morocco): ar_MA
  • Arabic (Oman): ar_OM
  • Arabic (Qatar): ar_QA
  • Arabic (Saudi Arabia): ar_SA
  • Arabic (Sudan): ar_SD
  • Arabic (Syria): ar_SY
  • Arabic (Tunisia): ar_TN
  • Arabic (United Arab Emirates): ar_AE
  • Arabic (Yemen): ar_YE
  • Armenian: hy
  • Basque: eu
  • Bosnian: bs
  • Bengali: bn
  • Burmese: my
  • Catalan: ca
  • Chinese (Hong Kong): zh_HK
  • Chinese (Singapore): zh_SG
  • Chinese (Malaysia): zh_MY
  • Dutch (Belgium): nl_BE
  • English (Australia): en_AU
  • English (Belgium): en_BE
  • English (Canada): en_CA
  • English (Cyprus): en_CY
  • English (Germany): en_DE
  • English (Hong Kong): en_HK
  • English (India): en_IN
  • English (Ireland): en_IE
  • English (Israel): en_IL
  • English (Malaysia): en_MY
  • English (Malta): en_MT
  • English (Netherlands): en_NL
  • English (New Zealand): en_NZ
  • English (Philippines): en_PH
  • English (Singapore): en_SG
  • English (South Africa): en_ZA
  • English (United Arab Emirates): en_AE
  • Estonian: et
  • Farsi: fa
  • French (Belgium): fr_BE
  • French (Canada): fr_CA
  • French (Luxembourg): fr_LU
  • French (Morocco): fr_MA
  • French (Switzerland): fr_CH
  • Georgian: ka
  • German (Austria): de_AT
  • German (Belgium): de_BE
  • German (Luxembourg): de_LU
  • German (Switzerland): de_CH
  • Greek (Cyprus): el_CY
  • Greenlandic: kl
  • Gujarati: gu
  • Hawaiian: haw
  • Haitian Creole: ht
  • Hindi: hi
  • Hmong: hmn
  • Icelandic: is
  • Irish: ga
  • Italian (Switzerland): it_CH
  • Kannada: kn
  • Kazakh: kk
  • Khmer: km
  • Latvian: lv
  • Lithuanian: lt
  • Luxembourgish: lb
  • Macedonian: mk
  • Malay: ms
  • Malayalam: ml
  • Maltese: mt
  • Marathi: mr
  • Montenegrin: sh_ME
  • Punjabi: pa
  • Romanian (Moldova): ro_MD
  • Romansh: rm
  • Russian (Armenia): ru_AM
  • Russian (Belarus): ru_BY
  • Russian (Kazakhstan): ru_KZ
  • Russian (Kyrgyzstan): ru_KG
  • Russian (Lithuania): ru_LT
  • Russian (Moldova): ru_MD
  • Russian (Poland): ru_PL
  • Russian (Ukraine): ru_UA
  • Samoan: sm
  • Serbian (Cyrillic): sr
  • Serbian (Latin): sh
  • Spanish (Argentina): es_AR
  • Spanish (Bolivia): es_BO
  • Spanish (Chile): es_CL
  • Spanish (Colombia): es_CO
  • Spanish (Costa Rica): es_CR
  • Spanish (Dominican Republic): es_DO
  • Spanish (Ecuador): es_EC
  • Spanish (El Salvador): es_SV
  • Spanish (Guatemala): es_GT
  • Spanish (Honduras): es_HN
  • Spanish (Nicaragua): es_NI
  • Spanish (Panama): es_PA
  • Spanish (Paraguay): es_PY
  • Spanish (Peru): es_PE
  • Spanish (Puerto Rico): es_PR
  • Spanish (United States): es_US
  • Spanish (Uruguay): es_UY
  • Spanish (Venezuela): es_VE
  • Swahili: sw
  • Tagalog: tl
  • Tamil: ta
  • Te reo: mi
  • Telugu: te
  • Urdu: ur
  • Welsh: cy
  • Xhosa: xh
  • Yiddish: ji
  • Zulu: zu

Before enabling Urdu as a platform-only language, review the right-to-left language support limitations.

Local translations are stored in a file with a format of localeCode.translation, where localeCode is the locale code of the translation language. For example, the file name for German translations is de.translation. Packaged translations are stored in a file with a format of pkgNamespace_ _``localeCode``.translation. For example, if the package namespace is Acme, the file name for German translations installed by the package is Acme_ _de.translation. The supported locale codes are listed in Language.

Custom object translations are stored in the objectTranslations folder in the corresponding package directory.

Introduced in API version 14.0.

  • Type: BotBlockTranslation[]
  • Required: No
  • Introduced: API version 59.0
  • Description: A list of bot block translations.
  • Type: BotTranslation[]
  • Required: No
  • Introduced: API version 53.0
  • Description: A list of bot translations.
  • Type: BotTemplateTranslation[]
  • Required: No
  • Introduced: API version 59.0
  • Description: A list of bot template translations.
  • Type: ContextDefinitionTranslation[]
  • Required: No
  • Introduced: API version 62.0
  • Description: A list of Context Service context definition translations.
  • Type: DashboardTranslation[]
  • Required: No
  • Introduced: API version 67.0
  • Description: A list of dashboard title and description translations. Dashboard translations are automatically discoverable by the Translation Workbench when enabled.

  • Type: FlowDefinitionTranslation[]

  • Required: No

  • Introduced: API version 41.0

  • Description: A list of flow translations.

    Only Flow and AutolaunchedFlow types are supported for translation.

  • Type: string

  • Required: No

  • Description: Required. The language code. For example, de for German.

    Inherited from Metadata, this field is defined in the WSDL for this metadata type. It must be specified when creating, updating, or deleting. For an example of this field specified for a call, see createMetadata().

  • Type: GlobalPicklistTranslation[]
  • Required: No
  • Description: A list of global picklist translations. A global picklist’s value set is inherited by all the custom picklist fields that are based on it. Available in API version 37.0 only and is removed from later versions.
  • Type: PromptTranslation[]
  • Required: No
  • Introduced: API version 48.0
  • Description: A list of In-App Guidance prompt translations.
  • Type: ReportAggregateTranslation[]
  • Required: No
  • Introduced: API version 68.0
  • Description: A list of Lightning Experience report aggregate translations.
  • Type: ReportBucketFieldTranslation[]
  • Required: No
  • Introduced: API version 68.0
  • Description: A list of Lightning Experience report bucket field translations.
  • Type: ReportChartTranslation[]
  • Required: No
  • Introduced: API version 68.0
  • Description: A list of Lightning Experience report chart translations.
  • Type: ReportTranslation[]
  • Required: No
  • Introduced: API version 67.0
  • Description: A list of Lightning Experience report name translations. Report translations are automatically discoverable by the Translation Workbench when enabled.

AiCoachAgentScnrDefTranslation contains details for the translation of Agentforce Sales Coach scenarios.

Introduced in API version 64.0.

  • Type: string
  • Required: No
  • Description: The description of the coaching scenario
  • Type: string
  • Required: No
  • Description: The title of the coaching scenario
  • Type: string
  • Required: Yes
  • Description: Required. Name of the coaching scenario.
  • Type: string
  • Required: No
  • Description: The instructions that the rep must follow before starting the coaching session

BotBlockTranslation contains details for a translation of a bot block.

Introduced in API version 59.0.

  • Type: string
  • Required: Yes
  • Description: Required. The name of the bot block.

BotBlockVersionTranslation contains details for a translation of a bot block version.

Introduced in API version 59.0.

  • Type: BotDialogTranslation[]
  • Required: No
  • Description: A list of bot dialog translations for the bot block version
  • Type: string
  • Required: Yes
  • Description: Required. The name of the bot block version.

BotDialogTranslation contains details for a translation of a bot dialog.

Introduced in API version 53.0.

  • Type: BotStepTranslation[]
  • Required: No
  • Description: A translated list of steps that are executed as part of the dialog

  • Type: string

  • Required: Yes

  • Description: Required. This unique name prevents conflicts with other dialogs associated with the same bot version.

    The developerName for the translation must match the developerName on the original BotDialog subtype of BotVersion.

  • Type: string
  • Required: No
  • Description: A translated label that identifies the dialog throughout the Salesforce user interface

In Metadata Deployment of Translations, it’s expected that blank values cannot be used to delete existing translations. If a translation label is left blank, it’s skipped during deployment, and no error is shown.

BotMessageTranslation contains details for a translation of a bot message step.

Introduced in API version 53.0.

  • Type: string
  • Required: No
  • Description: A translated message to show as part of an outgoing message from the bot to the customer

  • Type: string

  • Required: Yes

  • Description: Required. A unique key that identifies a message within a dialog. This key is used to link translated labels to labels within the message. This field is recommended for all message records and is required for translated message labels.

    The messageIdentifier for the translation must match the messageIdentifier on the original BotMessage subtype of BotVersion.

BotQuickReplyOptionTranslation contains details for a translation of a bot quick reply option within a bot variable operation (question) step.

Introduced in API version 53.0.

  • Type: string
  • Required: No
  • Description: A translated value to be shown as a menu or button choice to your customer.

  • Type: string

  • Required: Yes

  • Description: Required. A unique key that identifies a quick reply option within a dialog. This key is used to link translated labels to labels within the quick reply option. This field is recommended for all quick reply option records and is required for translated quick reply option labels.

    The quickReplyOptionIdentifier for the translation must match the quickReplyOptionIdentifier on the original BotQuickReplyOption subtype of BotVersion.

BotStepTranslation contains details for a translation of a bot step.

Introduced in API version 53.0.

  • Type: BotMessageTranslation[]
  • Required: No
  • Description: A translated list of bot messages used by a BotStep of type Message
  • Type: BotStepTranslation[]
  • Required: No
  • Description: A translated list of bot steps associated with a BotStep of type Group

  • Type: string

  • Required: Yes

  • Description: Required. A unique key that identifies a step within a dialog. This key is used to link translated labels to labels within the step. This field is recommended for all step records and is required for translated step labels.

    The stepIdentifier for the translation must match the stepIdentifier on the original BotStep subtype of BotVersion.

  • Type: BotStepType (enumeration of type string)

  • Required: Yes

  • Description: Required.

    The type for the translation must match the type on the original BotStep subtype of BotVersion.

  • Possible values:

    • Navigation
    • Invocation
    • VariableOperation
    • Message
    • Wait
    • Group
    • RecordLookup — (Available in API version 48.0 and later.)

BotTemplateTranslation contains details for a translation of a bot template.

Introduced in API version 59.0.

  • Type: BotDialogTranslation[]
  • Required: No
  • Description: A list of bot dialog translations for the bot template
  • Type: string
  • Required: Yes
  • Description: Required. The name of the bot template.

BotTranslation contains details for a translation of a bot.

Introduced in API version 53.0.

  • Type: string

  • Required: Yes

  • Description: Required. Name of the bot.

    The fullName for the translation must match the fullName inherited by the original Bot type.

BotVariableOperationTranslation contains details for a translation of a bot variable operation (question) step.

Introduced in API version 53.0.

  • Type: BotMessageTranslation[]
  • Required: No
  • Description: A translated list of bot messages used as prompt messages by a BotVariableOperation of type Collect
  • Type: BotQuickReplyOptionTranslation[]
  • Required: No
  • Description: A translated list of static choice options used by a BotVariableOperation of type Collect and quickReplyType of Static
  • Type: string
  • Required: No
  • Description: A translated formula template used to resolve a label for Dynamic choice options of type Object
  • Type: BotMessageTranslation[]
  • Required: No
  • Introduced: API version 57.0
  • Description: In a File dialog step, the translated message shown to the customer as part of type CollectAttachment to confirm a successful file upload.
  • Type: BotVariableOperationType (enumeration of type string)
  • Required: Yes
  • Description: Required.
  • Possible values:
    • Set
    • Unset
    • Collect
    • SetConversationLanguage

  • Type: string

  • Required: Yes

  • Description: Required. A unique key that identifies a variable operation within a dialog. This key is used to link translated labels to labels within the variable operation. This field is recommended for all variable operation records and is required for translated variable operation labels.

    The variableOperationIdentifier for the translation must match the variableOperationIdentifier on the original BotVariableOperation subtype of BotVersion.

BotVersionTranslation contains details for a translation of a bot version.

Introduced in API version 53.0.

  • Type: string

  • Required: Yes

  • Description: Required. Name of a bot version.

    The fullName for the translation must match the fullName inherited by the original BotVersion type.

ContextDefinitionTranslation contains details for a translation of a Context Service context definition.

Introduced in API version 62.0.

  • Type: string
  • Required: No
  • Description: The translated description of the context definition.
  • Type: string
  • Required: Yes
  • Description: Required. The translated label of the context definition.
  • Type: string
  • Required: Yes
  • Description: Required. The name of the context definition.

ConversationMessageConstantValueTranslation contains details for a translation of a conversation message constant value.

Introduced in API version 61.0.

  • Type: string
  • Required: Yes
  • Description: Required. The name of the conversation message constant value.
  • Type: string
  • Required: Yes
  • Description: Required. The translated constant value.

CustomApplicationTranslation contains details for a custom application translation. For more details, see CustomApplication.

  • Type: string
  • Required: No
  • Description: Description text for the application translation.
  • Type: string
  • Required: No
  • Description: The translated custom application name. Maximum of 765 characters.
  • Type: string
  • Required: Yes
  • Description: Required. The name of the custom application.

CustomLabelTranslation contains details for a custom label translation. For more details, see CustomLabels.

  • Type: string
  • Required: Yes
  • Description: Required. The translated custom label name. Maximum of 765 characters.
  • Type: string
  • Required: Yes
  • Description: Required. The custom label name.

CustomPageWebLinkTranslation contains details for a translation of a web link defined in a home page component. For more details, see CustomPageWebLink.

  • Type: string
  • Required: Yes
  • Description: Required. The translated web link.
  • Type: string
  • Required: Yes
  • Description: Required. The name of the web link.

CustomTabTranslation contains details for a translation of a custom tab. For more details, see CustomTab.

  • Type: string
  • Required: Yes
  • Description: Required. The translated custom tab name.
  • Type: string
  • Required: Yes
  • Description: Required. The custom tab name.

DashboardComponentTranslation contains details for a translation of a Lightning Experience dashboard components. For more details, see DashboardComponent.

  • Type: string
  • Required: No
  • Description: The dashboard component description.
  • Type: string
  • Required: No
  • Description: The dashboard component footer.
  • Type: string
  • Required: No
  • Description: The dashboard component label.
  • Type: string
  • Required: Yes
  • Description: Required. The dashboard component name.

DashboardTranslation contains details for a translation of a Lightning Experience dashboard. For more details, see Dashboard.

  • Type: string
  • Required: No
  • Description: The dashboard description.
  • Type: string
  • Required: No
  • Description: The dashboard label.
  • Type: string
  • Required: Yes
  • Description: Required. The dashboard name.

DataConnectorAttributeOptTranslation contains details for a translation of a data connector attribute option. For more information, see Data Cloud Connector Framework.

Introduced in API version 64.0.

  • Type: string
  • Required: Yes
  • Description: Required. The translated label for the attribute option.
  • Type: string
  • Required: Yes
  • Description: Required. The name of the attribute option.

DataConnectorAttributeTranslation contains details for a translation of a data connector attribute. For more information, see Data Cloud Connector Framework.

Introduced in API version 64.0.

  • Type: string
  • Required: No
  • Description: The translated error message for the attribute
  • Type: string
  • Required: No
  • Description: The translated info message for the attribute
  • Type: string
  • Required: No
  • Description: The translated input label for the attribute
  • Type: string
  • Required: Yes
  • Description: Required. The translated label for the attribute.
  • Type: string
  • Required: Yes
  • Description: Required. The name of the attribute.

DataConnectorErrorTranslation contains details for a translation of a data connector error. For more information, see Data Cloud Connector Framework.

Introduced in API version 64.0.

  • Type: string
  • Required: Yes
  • Description: Required. The translated label for the error.
  • Type: string
  • Required: Yes
  • Description: Required. The name of the error.

DataConnectorTranslation contains details for a translation of a data connector.

Introduced in API version 64.0.

  • Type: string
  • Required: No
  • Description: The translated description for the data connector
  • Type: string
  • Required: No
  • Description: The translated help text for the data connector
  • Type: string
  • Required: No
  • Description: The translated label for the data connector
  • Type: string
  • Required: No
  • Description: The language for the data connector translation
  • Type: string
  • Required: No
  • Description: The name of the data connector

ExplainabilityMsgTemplateFieldTranslation represents the template that contains the decision explanation message for a specified step element type.

  • Type: string
  • Required: No
  • Description: The explainability message field description
  • Type: string
  • Required: No
  • Description: A user-friendly name for ExplainabilityMsgTemplateFieldTranslation
  • Type: string
  • Required: Yes
  • Description: Required. The name of the decision explanation message for a specified step element type.
  • Type: string
  • Required: No
  • Description: The message associated with the template for a specific expression set step type

FlowChoiceTranslation contains details for a translation of a choice in a flow version. For more details, see FlowChoice in Flow.

Introduced in API version 41.0.

  • Type: string
  • Required: No
  • Description: A translated label for the choice
  • Type: string
  • Required: Yes
  • Description: Required. A unique name for the choice.

FlowChoiceUserInputTranslation contains details for a translation of a choice input. For more details, see FlowChoiceUserInput in Flow.

Introduced in API version 41.0.

  • Type: string
  • Required: No
  • Description: A translated label for the choice input

FlowComplexLiteralTranslation is reserved for internal use.

  • Type: string
  • Required: No
  • Description: Reserved for internal use
  • Type: string
  • Required: No
  • Description: Reserved for internal use
  • Type: string
  • Required: Yes
  • Description: The unique developer name of this component. Used as an API reference and must follow Salesforce identifier rules.
  • Type: string
  • Required: No
  • Type: string
  • Required: No

FlowDefinitionTranslation contains details for a translation of a flow definition. For more details, see FlowDefinition.

Introduced in API version 41.0.

  • Type: FlowTranslation[]
  • Required: No
  • Description: A list of flow version translations for the flow definition
  • Type: string
  • Required: Yes
  • Description: Required. The API name for the flow definition.

  • Type: string

  • Required: No

  • Description: A translated label for the flow definition.

    By default, flow definitions inherit the label of the active flow version. If you provide a label here, the definition label no longer inherits changes to the active version label.

FlowFerovTranslation is reserved for internal use.

  • Type: string
  • Required: No
  • Description: Reserved for internal use

FlowInputParameterTranslation is reserved for internal use.

  • Type: string
  • Required: Yes
  • Description: Reserved for internal use

FlowInputValidationRuleTranslation contains details for a translation of a validation rule. For more details, see FlowInputValidationRule in Flow.

Introduced in API version 41.0.

  • Type: string
  • Required: No
  • Description: A translated error message for the validation rule

FlowOrchestrationStageTranslation contains details for a translation of an orchestration stage in an orchestration version. For more details, see FlowOrchestratedStage in Flow.

Introduced in API version 64.0.

  • Type: string
  • Required: Yes
  • Description: Required. The unique name of the orchestration stage translation.
  • Type: string
  • Required: No
  • Description: A translated label for the orchestration stage

FlowOrchestrationStepTranslation contains details for a translation of an orchestration step in an orchestration version. For more details, see FlowStageStep in Flow.

Introduced in API version 63.0.

  • Type: string
  • Required: Yes
  • Description: Required. The unique name of the orchestration step translation.
  • Type: string
  • Required: No
  • Description: A translated label for the orchestration step

FlowScreenFieldTranslation contains details for a translation of a screen component. For more details, see FlowScreenField in Flow.

Translation isn’t supported for screen components that require Lightning runtime.

Introduced in API version 41.0.

Translation isn’t supported for screen components that require Lightning runtime.
  • Type: string
  • Required: No
  • Description: A translated label for the screen component
  • Type: string
  • Required: No
  • Description: Translated help text for the screen component
  • Type: string
  • Required: Yes
  • Description: Required. An API name for the screen component.

FlowScreenTranslation contains details for a translation of a screen. For more details, see FlowScreen in Flow.

Introduced in API version 41.0.

  • Type: string
  • Required: No
  • Introduced: API version 54.0
  • Description: A translated label for the Back button.
  • Type: string
  • Required: No
  • Description: Translated help text for the screen
  • Type: string
  • Required: Yes
  • Description: Required. An API name for the screen.
  • Type: string
  • Required: No
  • Introduced: API version 54.0
  • Description: A translated label for the Next or Finish button.
  • Type: string
  • Required: No
  • Introduced: API version 54.0
  • Description: A translated label for the Pause button.
  • Type: string
  • Required: No
  • Description: A translated pause confirmation message for the screen

FlowStageTranslation contains details for a translation of a stage in a flow version. For more details, see FlowStage in Flow.

Introduced in API version 43.0.

  • Type: string
  • Required: No
  • Description: A translated label for the stage
  • Type: string
  • Required: Yes
  • Description: Required. An API name for the stage.

FlowTextTemplateTranslation is available only in flows created via Salesforce Surveys and represents the translation details for the text on all the pages of a survey.

Introduced in API version 45.0.

  • Type: string
  • Required: Yes
  • Description: Required. Unique name for the text template.
  • Type: string
  • Required: No
  • Description: Translated text for the text template

FlowTranslation contains details for a translation of a flow version. For more details, see Flow.

Introduced in API version 41.0.

  • Type: string

  • Required: No

  • Description: The API name for the flow version.

    A unique name for the flow that contains only underscores and alphanumeric characters. The name must be unique across the org, begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.

    To deploy or retrieve a version, you can specify the version number. For example, sampleFlow-3 specifies version 3 of the flow whose unique name is sampleFlow. If you don’t specify a version number, the flow is the latest version.

    In API version 43.0 and earlier, this field included the version number. In API version 44 and later, this field no longer includes the version number.

  • Type: string
  • Required: No
  • Description: A translated label for the flow version
  • Type: FlowStageTranslation[]
  • Required: No
  • Introduced: API version 43.0
  • Description: A list of stage translations for the flow version.

GlobalPicklistTranslation is available in API version 37.0 only and is removed from later versions.

GlobalPicklistTranslation contains details for a global picklist translation.

Translations are stored in a file with a format of globalPicklistName__e-lang.objectTranslation, where globalPicklistName__e is the global picklist name and lang is the translation language. To reference a global picklist translation value, use globalPicklistName__e.value1, where value1 is the translated value for the user interface.

Here’s what translations look like for a global picklist.

GlobalPicklistTranslation is available in API version 37.0 only and is removed from later versions.
  • Type: string
  • Required: Yes
  • Description: Required. Represents the name of a global picklist to be translated.

GlobalQuickActionTranslation contains details for the global translation of a quick action. For more information, see QuickAction.

  • Type: string
  • Required: No
  • Introduced: API version 53.0
  • Description: Identifies which quick action label the translated text belongs to. Use this field only when you want to use different strings for the quick action’s field label and informational message. Valid values are Master and InfoMessage.
  • Type: string
  • Required: Yes
  • Description: Required. The translated quick action name, globally.
  • Type: string
  • Required: Yes
  • Description: Required. The quick action name.

Translates the UI components associated with identity verification fields.

Introduced in API version 54.0.

  • Type: string
  • Required: No
  • Description: The custom label for the field that contains the verification data
  • Type: string
  • Required: No
  • Description: The identity verification field description
  • Type: string
  • Required: No
  • Description: A user-friendly name for IdentityVerificationFieldTranslation
  • Type: string
  • Required: Yes
  • Description: Required. The name of the identity verification field.
  • Type: string
  • Required: Yes
  • Description: The label that identifies this component in the Salesforce UI and in metadata listings. Character limits and translation behavior follow the enclosing type.
  • Type: string
  • Required: Yes
  • Type: string
  • Required: Yes
  • Description: The label that identifies this component in the Salesforce UI and in metadata listings. Character limits and translation behavior follow the enclosing type.
  • Type: string
  • Required: Yes

PipelineInspMetricConfigTranslation contains details for the translation of Pipeline Inspection forecast category metric settings.

Introduced in API version 57.0.

  • Type: string
  • Required: Yes
  • Description: Required. The translated Pipeline Inspection metric configuration name.
  • Type: string
  • Required: Yes
  • Description: Required. The name of the Pipeline Inspection metric configuration.

ProductSpecificationTypeTranslation contains details for a translation of a product specification type. For more details, see ProductSpecificationType.

Introduced in API version 66.0.

  • Type: string
  • Required: No
  • Description: The translated product specification type description.
  • Type: string
  • Required: No
  • Description: The translated product specification type name.
  • Type: string
  • Required: Yes
  • Description: Required. The name of the product specification type.

PromptTranslation contains metadata for the translation of a prompt, which is part of In-App Guidance.

Introduced in API version 48.0.

  • Type: string
  • Required: No
  • Description: The prompt description
  • Type: string
  • Required: No
  • Description: The translated prompt name
  • Type: string
  • Required: Yes
  • Description: Required. The name of the prompt.

PromptVersionTranslation contains details for translation of a prompt, which is part of In-App Guidance.

Introduced in API version 48.0.

  • Type: string
  • Required: No
  • Description: The label for the prompt’s action button
  • Type: string
  • Required: No
  • Description: The URL for the prompt’s action button
  • Type: string
  • Required: No
  • Description: The body text of the prompt
  • Type: string
  • Required: No
  • Description: The prompt description
  • Type: string
  • Required: No
  • Description: The label for the floating prompt’s dismiss button
  • Type: string
  • Required: No
  • Description: The header for the docked prompt
  • Type: string
  • Required: No
  • Introduced: API version 53.0
  • Description: The alt text for a prompt’s image.
  • Type: string
  • Required: No
  • Introduced: API version 53.0
  • Description: The URL for a prompt’s image.
  • Type: string
  • Required: No
  • Description: The translated prompt name
  • Type: string
  • Required: Yes
  • Description: Required. The name of the prompt.
  • Type: int
  • Required: No
  • Type: string
  • Required: No
  • Description: The title of the prompt
  • Type: string
  • Required: No
  • Description: The URL for the docked prompt’s video

RecordAlertCategoryTranslation contains details for a translation of a record alert category.

Introduced in API version 66.0.

  • Type: string
  • Required: No
  • Description: The translated description for the record alert category
  • Type: string
  • Required: Yes
  • Description: Required. The translated label for the record alert category.
  • Type: string
  • Required: Yes
  • Description: Required. The name of the record alert category.

RecordAlertTemplateTranslation contains details for a translation of a record alert template.

Introduced in API version 66.0.

  • Type: string
  • Required: No
  • Description: The translated description for the record alert template
  • Type: string
  • Required: No
  • Description: The translated label for the record alert template
  • Type: string
  • Required: Yes
  • Description: Required. The name of the record alert template.
  • Type: string
  • Required: No
  • Description: The translated subject for the record alert template

ReportAggregateTranslation contains details for a translation of a Lightning Experience report aggregate. For more details, see ReportAggregate.

  • Type: string
  • Required: No
  • Description: The aggregate label.
  • Type: string
  • Required: Yes
  • Description: Required. The aggregate name.
  • Type: string
  • Required: Yes
  • Description: Required. The report name for the aggregate.

ReportBucketFieldTranslation contains details for a translation of a Lightning Experience report bucket field. For more details, see ReportBucketField.

  • Type: string
  • Required: No
  • Description: The bucket field label.
  • Type: string
  • Required: Yes
  • Description: Required. The bucket field name.
  • Type: string
  • Required: Yes
  • Description: Required. The report name for the bucket field.

ReportChartTranslation contains details for a translation of a Lightning Experience report chart. For more details, see ReportChart.

  • Type: string
  • Required: No
  • Description: The chart label.
  • Type: string
  • Required: Yes
  • Description: Required. The chart name.
  • Type: string
  • Required: Yes
  • Description: Required. The report name for the chart.

ReportTranslation contains details for a translation of a Lightning Experience report. For more details, see Report.

  • Type: string
  • Required: No
  • Description: The report description.
  • Type: string
  • Required: No
  • Description: The report label.
  • Type: string
  • Required: Yes
  • Description: Required. The report name.

ReportTypeColumnTranslation contains details for a Lightning Experience report type column translation.

  • Type: string
  • Required: Yes
  • Description: Required. The translated report type column name.
  • Type: string
  • Required: Yes
  • Description: Required. The report type column name.

ReportTypeSectionTranslation contains details for a Lightning Experience report type section translation.

  • Type: string
  • Required: No
  • Description: The translated report type section name
  • Type: string
  • Required: Yes
  • Description: Required. The name of the report type section.

ReportTypeTranslation contains details for a translation of a custom Lightning Experience report type. For more details, see ReportType.

  • Type: string
  • Required: No
  • Description: The translated report type description
  • Type: string
  • Required: No
  • Description: The translated report type name
  • Type: string
  • Required: Yes
  • Description: Required. The name of the report type.

ScontrolTranslation contains details for a translation of an s-control. For more information, see “About S-Controls” in Salesforce Help.

Visualforce pages supersede s-controls. Organizations that haven’t previously used s-controls can’t create them. Existing s-controls are unaffected and can still be edited.

Visualforce pages supersede s-controls. Organizations that haven’t previously used s-controls can’t create them. Existing s-controls are unaffected and can still be edited.
  • Type: string
  • Required: Yes
  • Description: Required. The translated s-control name.
  • Type: string
  • Required: Yes
  • Description: Required. The name of the s-control.

ServiceProcessAttributeTranslation contains details for a translation of a service process attribute.

Introduced in API version 64.0.

  • Type: string
  • Required: Yes
  • Description: Required. The translated label for the service process attribute.
  • Type: string
  • Required: Yes
  • Description: Required. The name of the service process attribute.
  • Type: string
  • Required: Yes
  • Description: Required. The name of the service process.

ServiceProcessItemGroupTranslation contains details for a translation of a service process item group.

Introduced in API version 64.0.

  • Type: string
  • Required: Yes
  • Description: Required. The name of the service process item group.
  • Type: string
  • Required: Yes
  • Description: Required. The name of the service process item group translation.
  • Type: string
  • Required: Yes
  • Description: Required. The name of the service process.

Contains details for a translation of a timeline object definition.

Introduced in API version 66.0.

  • Type: string
  • Required: No
  • Description: Translated label for the timeline object definition
  • Type: string
  • Required: Yes
  • Description: Required. Name of the timeline object definition

This is an example of an ExplainabilityMsgTemplateFieldTranslation component.

This is an example of an IdentityVerificationFieldTranslation component.

This sample XML definition shows a translations component.

When you use the retrieve() call to get translations, the files returned in the .translations folder only include translations for the other metadata types referenced in package.xml. For example, this package.xml file contains types elements that match all custom applications, custom labels, web links defined in home page components, custom tabs, report types, and s-controls. Translations for all these metadata types are returned because each metadata type is explicitly listed in package.xml.

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.