Coghub icon

Coghub

Interagir com a API do Coghub

Actions129

Help Center → Add New Portal To Account

AI-generated

Summary

Create a new help center portal in your Coghub account by specifying its customization details such as name, URL slug, appearance, and configuration.

Inputs

  • name (required) — Name for the help center portal.
  • slug (required) — URL-friendly slug displayed in the portal link.
  • color — Header color for the help center specified as a hex code (default: #FFFFFF).
  • custom_domain — Custom domain to use for displaying the help center instead of the default.
  • header_text — Text displayed in the help center header.
  • homepage_link — URL link to the main dashboard or homepage.
  • page_title — Title text for the help center page.
  • archived — Boolean status indicating if the portal is archived (not live).
  • config — JSON configuration for localization and supported languages (including allowed_locales and default_locale).
  • requestOptions — Advanced HTTP request options such as proxy, timeout, batching, and SSL certificate handling.

Output shape

a single JSON object representing the created help center portal with all supplied properties and system-generated values

The operation returns the newly created portal object. Optional inputs can be omitted, and defaults will apply. No pagination is involved.

Examples

Example 1: Add a new portal named 'Handbook' with English and Spanish locales, custom branding color, and a custom domain.

Name='Handbook', Slug='handbook', Color='#FFFFFF', Custom Domain='coghub.help', Config={allowed_locales:['en','es'], default_locale:'en'}

Links

Discussion