Site external links

Manage links to external destinations in a site's navigation.

External links add absolute HTTP or HTTPS destinations alongside sections and groups in a site's navigation.

The SiteExternalLink object

Attributes

objectstring · enumRequired

The object type, which is always "site-external-link"

Possible values:

idstringRequired

Unique identifier of the external link

titlestring · min: 2 · max: 128Required

Title of the site section

descriptionstring · max: 256Optional

Description of the site section

iconstring · icon · max: 50Optional

Name of the icon

Example: gear

urlstring · uri · max: 2048Required

Absolute HTTP or HTTPS URL opened by the external link

sectionGroupstringOptional

ID of the section group the external link belongs to. Omitted for a root link.

draftbooleanRequired

Whether the external link is draft and not live

conditionstring · max: 1024Optional

Conditional expression used to evaluate whether the external link should be shown to the site's visitor

The SiteExternalLink object

{
  "object": "site-external-link",
  "id": "text",
  "title": "text",
  "localizedTitle": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "description": "text",
  "localizedDescription": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "icon": "gear",
  "url": "https://example.com",
  "sectionGroup": "text",
  "draft": true,
  "condition": "text"
}