Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

ExternalString

Represents a custom label for a translatable UI component. Includes access to the associated label in the Metadata API. Available in API version 38.0 and later.

Supported SOAP Calls

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

Supported REST HTTP Methods

DELETE, GET, PATCH, POST

Limitations

SOSL Limitations

Fields

Field	Details
Category	Type string 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 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` .
Language	Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort Description The language of the custom label. You can’t change the language of an existing custom label. Note
ManageableState	Type ManageableState enumerated list 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`
MasterLabel	Type string 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 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 Properties Filter, Group, Nillable, Sort Description The namespace of the package of which the custom label is a part.
Value	Type string 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.

Tooling API

ExternalString

Supported SOAP Calls

Supported REST HTTP Methods

Limitations

Fields