EmbeddedServiceBranding

Represents branding for each Embedded Service deployment.

Version 

Introduced in API version 39.0.

Supported SOAP API Calls 

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

Supported REST API Methods 

DELETE, GET, HEAD, PATCH, POST, Query

Fields 

ContrastInvertedColor 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 42.0

• Description: Accent branding color used in the embedded component, displayed as a hexadecimal value. Changes made to this field in the API aren’t reflected in the embedded component.

ContrastPrimaryColor 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 39.0

• Description: Accent branding color used in the embedded component, displayed as a hexadecimal value.

DeveloperName 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Description: The unique name of the branding component.

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. This field is automatically generated, but you can supply your own value if you create the record using the API.

When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record.

Note

Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field.

Note

EmbeddedServiceConfigId 

• Type: reference

• Required: No

• Properties: Filter, Group, Sort

• Relationship name: EmbeddedServiceConfig

• Relationship type: relationship

• Refers to: EmbeddedServiceConfig

Font 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 39.0

• Description: Font used in the text of the embedded component.

FullName 

• Type: string

• Required: No

• Properties: Create, Group, Nillable

• Introduced: API version 43.0

• Description: The full name of the associated EmbeddedServiceBranding in Metadata API. The full name can include a namespaceprefix.

Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.

Height 

• Type: int
• Required: No
• Properties: Filter, Group, Nillable, Sort
• Introduced: API version 43.0

Language 

• Type: picklist

• Required: No

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

• Description: The language of the embedded component.

• 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

  • ar — ar — Arabic

  • iw — iw — Hebrew

  • nl_BE — nl_BE — Dutch (Belgium)

  • ur — ur — Urdu

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: Filter, Group, Sort

• Description: Label for the embedded component.

Metadata 

• Type: complexvalue

• Required: No

• Properties: Create, Nillable, Update

• Introduced: API version 43.0

• Description: The embedded service branding’s metadata.

Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.

NamespacePrefix 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix__componentName notation.

The namespace prefix can have one of the following values.

• In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer.
• In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix.

NavBarColor 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 39.0

• Description: Color used for the navigation bar in the embedded component.

NavBarTextColor 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 49.0

• Description: Color used for the text and icons in the header in the embedded component, displayed as a hexadecimal value.

PrimaryColor 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 39.0

• Description: Primary branding color used in the embedded component.

SecondaryColor 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 39.0

• Description: Secondary branding color used in the embedded component.

SecondaryNavBarColor 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 49.0

• Description: Secondary branding color used for the header in the embedded component, displayed as a hexadecimal value. It applies to the header in the chat feature when it’s trying to reconnect because of lost internet connection.

Width 

• Type: int
• Required: No
• Properties: Filter, Group, Nillable, Sort
• Introduced: API version 43.0