Swagger: Create Portal Product
swagger_create_portal_productCreate a new portal product from scratch or copy an existing one, setting name, URL slug, and visibility.
Instructions
Create a new product for a specific portal.
Toolset: Products
Parameters:
portalId (string) required: Portal UUID or subdomain - unique identifier for the portal instance
type (string) required: Product creation type - 'new' to create from scratch or 'copy' to duplicate an existing product
productId (string): Source product UUID to copy from - required when type is 'copy', specifies which existing product to duplicate. Omit when type is 'new'
name (string) required: Product display name - will be shown to users in the portal navigation and product listings (3-40 characters)
slug (string) required: URL-friendly identifier for the product - must be unique within the portal, used in URLs (e.g., 'my-api' becomes /my-api). 3-22 characters, lowercase, alphanumeric with hyphens, underscores, or dots
description (string): Product description - explains what the API/product does, shown in product listings and cards (max 110 characters)
public (boolean): Whether the product is publicly visible to all portal visitors - false means only authenticated users with appropriate roles can access it
hidden (boolean): Whether the product is hidden from the portal landing page navigation menus - useful for internal or draft products
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Product display name - will be shown to users in the portal navigation and product listings (3-40 characters) | |
| slug | Yes | URL-friendly identifier for the product - must be unique within the portal, used in URLs (e.g., 'my-api' becomes /my-api). 3-22 characters, lowercase, alphanumeric with hyphens, underscores, or dots | |
| type | Yes | Product creation type - 'new' to create from scratch or 'copy' to duplicate an existing product | |
| hidden | No | Whether the product is hidden from the portal landing page navigation menus - useful for internal or draft products | |
| public | No | Whether the product is publicly visible to all portal visitors - false means only authenticated users with appropriate roles can access it | |
| portalId | Yes | Portal UUID or subdomain - unique identifier for the portal instance | |
| productId | No | Source product UUID to copy from - required when type is 'copy', specifies which existing product to duplicate. Omit when type is 'new' | |
| description | No | Product description - explains what the API/product does, shown in product listings and cards (max 110 characters) |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | ||
| name | No | ||
| slug | No | ||
| hidden | No | ||
| public | No | ||
| portalId | No | ||
| description | No |