Konverte Digital icon

Konverte Digital

Interact with Konverte Digital API
Join our community

Actions115

Overview

This node operation allows users to add a new help center portal to an account in the Konverte Digital system. It is useful for managing multiple help center portals under a single account, enabling customization of each portal's appearance and settings. For example, a company can create different portals for different regions or product lines, each with its own localized content and branding.

Use Case Examples

  1. Creating a new help center portal with a custom domain and localized support for English and Spanish.
  2. Adding a portal with a specific header color and homepage link to direct users to the main dashboard.

Properties

Name Meaning
Account Id The numeric ID of the account to which the new help center portal will be added.
Archived Status to check if the portal is live or archived.
Color Header color for the help center portal, specified as a HEX string.
Config JSON configuration for supporting locales, including allowed locales and the default locale.
Custom Domain Custom domain URL to display the help center portal.
Header Text Text to display in the header of the help center portal.
Homepage Link URL link to the main dashboard or homepage associated with the portal.
Name Name of the help center portal.
Slug Slug used in the URL to display the portal.
Page Title Page title for the help center portal.
Request Options Settings for request handling such as batching, SSL certificate validation, proxy usage, and timeout duration.

Output

JSON

  • id - Unique identifier of the newly created help center portal.
  • name - Name of the created portal.
  • slug - Slug used in the portal's URL.
  • archived - Boolean indicating if the portal is archived or active.
  • color - Header color of the portal.
  • config
    • allowed_locales - Array of locales supported by the portal.
    • default_locale - Default locale set for the portal.
  • custom_domain - Custom domain URL of the portal.
  • header_text - Header text displayed on the portal.
  • homepage_link - Link to the main dashboard or homepage.
  • page_title - Page title of the portal.

Dependencies

  • An API key credential for authenticating with the Konverte Digital API

Troubleshooting

  • Ensure the account ID is valid and exists in the system to avoid errors when adding a portal.
  • Verify that the JSON configuration for locales is correctly formatted to prevent parsing errors.
  • Check network connectivity and proxy settings if requests fail or time out.
  • If SSL certificate validation fails, consider enabling the option to ignore SSL issues, but be aware of security risks.

Links

Discussion