Update a portal instance

• Authorization

  string

  header

  required

  Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

• id

  string

  path

  required

  Portal instance id from GET /portal/instances.

• slug

  string

  URL segment the portal lives under: lowercase letters, numbers and hyphens, up to 40 characters. changelog, roadmap, docs, requests, api and main are reserved.

• name

  string
• show_in_selector

  boolean

  When false, the portal stays reachable by URL but is hidden from the portal switcher.

• logo_url

  string<uri> | null
• show_docs

  boolean
• show_changelog

  boolean
• show_roadmap

  boolean
• show_support

  boolean
• overrides_auth

  boolean

  Turn on to use this portal's auth fields instead of the workspace sign-in settings. Requires the admin scope.

• is_google_auth_required

  boolean

  Applies only with overrides_auth: true. Requires the admin scope.

• google_domain

  string | null

  Email domain allowed to sign in with Google, e.g. acme.com. Applies only with overrides_auth: true. Requires the admin scope.

• overrides_custom_links

  boolean

  Turn on to use this portal's header and footer links instead of the workspace ones.

• use_portal_logo_url

  boolean

  When true, the header logo links to portal_logo_url. Applies only with overrides_custom_links: true.

• portal_logo_url

  string<uri> | null
• changelog_link_1_description

  string | null
• changelog_link_1_url

  string<uri> | null
• changelog_link_2_description

  string | null
• changelog_link_2_url

  string<uri> | null
• overrides_theme

  boolean

  Turn on to use this portal's dark_mode and colors instead of the workspace theme.

• dark_mode

  boolean | null

  true forces dark mode, false forces light mode, null follows the visitor's system setting.

• accent_color

  string | null
• accent_text_color

  string | null
• button_text_color

  string | null
• dark_mode_accent_color

  string | null
• dark_mode_accent_text_color

  string | null
• dark_mode_button_text_color

  string | null
• portal_embed_image_url

  string<uri> | null

  Social preview image. null falls back to the workspace image.

• is_default

  boolean

  The default portal serves the unprefixed portal URL. Setting it takes the flag from any other portal; clearing it returns the URL to the Main portal.

Successful response

• id

  string

  required
• slug

  string

  required
• name

  string

  required
• is_default

  boolean

  required

  The default portal serves the unprefixed portal URL.

• show_in_selector

  boolean

  required
• logo_url

  string | null

  required
• custom_domain

  string | null

  required

  Set up in the dashboard, since it needs DNS records. Read-only here.

• show_docs

  boolean

  required
• show_changelog

  boolean

  required
• show_roadmap

  boolean

  required
• show_support

  boolean

  required
• overrides_auth

  boolean

  required

  When false, the portal uses the workspace sign-in settings and ignores the auth fields.

• is_google_auth_required

  boolean

  required
• google_domain

  string | null

  required
• overrides_custom_links

  boolean

  required

  When false, the portal uses the workspace header and footer links and ignores the link fields.

• use_portal_logo_url

  boolean

  required
• portal_logo_url

  string | null

  required
• changelog_link_1_description

  string | null

  required
• changelog_link_1_url

  string | null

  required
• changelog_link_2_description

  string | null

  required
• changelog_link_2_url

  string | null

  required
• overrides_theme

  boolean

  required

  When false, the portal uses the workspace theme and ignores dark_mode and the colors.

• dark_mode

  boolean | null

  required

  true forces dark mode, false forces light mode, null follows the visitor's system setting.

• accent_color

  string | null

  required
• accent_text_color

  string | null

  required
• button_text_color

  string | null

  required
• dark_mode_accent_color

  string | null

  required
• dark_mode_accent_text_color

  string | null

  required
• dark_mode_button_text_color

  string | null

  required
• portal_embed_image_url

  string | null

  required

  Social preview image. Falls back to the workspace image when null.

• created_at

  string

  required
• updated_at

  string

  required