Newer Version Available

This content describes an older version of this product. View Latest

Custom URL Detail

Definition of a custom domain.
Property Name Type Description Filter Group and Version Available Version
customUrlId String ID of the custom URL. Small, 62.0 62.0
domainId String ID of the custom domain. Small, 62.0 62.0
domainName String Domain Name Small, 62.0 62.0
path String The path on the domain, starting with a slash (/).

A slash (/) with no subsequent characters represents the root path, such as https://www.example.com.

You can use the same path for more than one domain, but you can use each path only once within the same domain.

Small, 62.0 62.0
primarySiteUrl Boolean Indicates whether this custom URL is the preferred URL for authenticated pages and email (true) or not (false).

This property applies only when the siteType is Community or SalesforceSite.

Each site can have only one primary custom URL. For more information, see Add a Custom URL in Salesforce Help.

Small, 62.0 62.0
siteId String ID of the site that this custom URL serves. Small, 62.0 62.0
siteName String Name of the site that this custom URL serves. Small, 62.0 62.0
siteType String Type of site that this custom URL serves.
  • Community—An Experience Cloud Site.
  • SalesforceSite—A Salesforce Site.
  • LegacySite—A legacy site type, such as legacy Site.com sites.
Small, 62.0 62.0