---
schema_version: "1"
id: a9b5f0fa73ed76fafbf9763c6e17f9ac556fc5682bf2deb721c74341664aa3a2
title: EmbeddedServiceBranding
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_embeddedservicebranding.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_embeddedservicebranding.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: b986169e31d6791ab3b9b2b5b19f72b746068f90e5554a31605ef4f4407be017
description: Represents the branding for each Embedded Service deployment. This type extends the Metadata metadata type and inherits its fullName field.
---
# EmbeddedServiceBranding

Represents the branding for each Embedded Service deployment. This type extends the Metadata metadata type and inherits its fullName field.

This object works only with the legacy chat products. For Messaging for In-app and Web, use the [BrandingSet](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_brandingset.htm "Represents the definition of a set of branding properties for an Experience Builder site or for your org's Lightning Experience theme.") object.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

EmbeddedServiceBranding components are stored in the developer\_name.EmbeddedServiceBranding file in the EmbeddedServiceBranding folder.

## Version

EmbeddedServiceBranding is available in API version 39.0 and later.

## Fields

| Field Name | Field Type | Description |
| --- | --- | --- |
| contrastInvertedColor | string | 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 | string | Accent branding color used in the embedded component, displayed as a hexadecimal value. |
| embeddedServiceConfig | string | Required. The Embedded Service configuration that this branding applies to. |
| font | string | Font used in the text of the embedded component. |
| height | int | Height of the embedded component. Available in API version 43.0 and later. |
| masterLabel | string | Required. The name of the Embedded Service configuration node. |
| navBarColor | string | Color used for the header in the embedded component, displayed as a hexadecimal value. |
| navBarTextColor | string | Color used for the text and icons in the header in the embedded component, displayed as a hexadecimal value. Available in API version 49.0 and later. |
| primaryColor | string | Primary branding color used in the embedded component, displayed as a hexadecimal value. |
| secondaryColor | string | Secondary branding color used in the embedded component, displayed as a hexadecimal value. |
| secondaryNavBarColor | string | 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. Available in API version 49.0 and later. |
| width | int | Width of the embedded component. Available in API version 43.0 and later. |

## Declarative Metadata Sample Definition

The following is an example of an EmbeddedServiceBranding file.

<?xml version="1.0" encoding="UTF-8"?>
<EmbeddedServiceBranding xmlns="http://soap.sforce.com/2006/04/metadata">
    <contrastInvertedColor\>#ffffff</contrastInvertedColor\>
    <contrastPrimaryColor\>#333333</contrastPrimaryColor\>
    <embeddedServiceConfig\>EswConfig001</embeddedServiceConfig\>
    <font\>Salesforce Sans</font\>
    <height\>498</height\>
    <masterLabel\>EmbeddedServiceBranding\_Parent04IRM000000002a\_16033cd2c16</masterLabel\>
    <navBarColor\>#222222</navBarColor\>
    <primaryColor\>#222222</primaryColor\>
    <secondaryColor\>#005290</secondaryColor\>
    <width\>320</width\>
</EmbeddedServiceBranding\>

## Wildcard Support in the Manifest File

This metadata type doesn’t support 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).