ExternalString

Represents a custom label for a translatable UI component. Includes access to the associated label in the Metadata API.

Version 

Introduced in API version 38.0.

Supported SOAP API Calls 

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

Supported REST API Methods 

DELETE, GET, HEAD, PATCH, POST, Query

Limitations 

SOSL Limitations

Fields 

Category 

• Type: string

• Required: No

• Properties: Create, Filter, Group, Nillable, Sort, Update

• Description: Text that categorizes the label, limited to 255 characters. Separate each category with a comma. This field can be used in filter criteria when creating custom label list views.

IsProtected 

• Type: boolean

• Required: No

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

• Description: Indicates whether the custom label is protected (true) or not (false). The default value is false .

• Default value: false

Language 

• Type: picklist

• Required: No

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

• Introduced: API version 17.0

• Description: The language of the custom label.

• 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

  You can’t change the language of an existing custom label.

  Note

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:

• beta

• deleted

• deprecated

• deprecatedEditable

• installed

• installedEditable

• released

• unmanaged

• Possible values:

  • beta — beta

  • deleted — deleted

  • deprecated — deprecated

  • deprecatedEditable — deprecatedEditable

  • installed — installed

  • installedEditable — installedEditable

  • released — released

  • unmanaged — unmanaged

MasterLabel 

• Type: string

• Required: No

• Properties: Create, Filter, Group, Sort, Update

• Description: An easily recognizable internal label to identify this custom label. This description is used in merge fields and is not translated.

Name 

• Type: string

• Required: No

• Properties: Create, Filter, Group, Sort

• Description: The name used in Apex and Visualforce pages to reference the custom label. Names must contain only alphanumeric characters, start with a letter, contain no spaces or double underscores, and be unique from all other labels in your org.

NamespacePrefix 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The namespace of the package of which the custom label is a part.

Value 

• Type: string

• Required: No

• Properties: Create, Filter, Sort, Update

• Description: The custom label value, limited to 1,000 characters. This value can be translated into any language that Salesforce supports.